Subscriptions

PATCH /Subscriptions/{id}

Request

  • Base URL
    https://api.liveswitch.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.liveswitch.io/Subscriptions/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Query parameters

api-versionstring

The requested API version

Request body

idstring nullable
organizationIdstring nullable

Your customer id.

statusstring nullable

Status of your current subscription. Example: "active", "paused", "cancelled"

trialEndOninteger nullable

Timestamp of when the subscription trial ends if applicable.

trialStartOninteger nullable

Timestamp of when the subscription trial has started if applicable.

activatedOninteger nullable

Timestamp of when the subscription was activated.

nextBillingOninteger nullable

Timestamp of when the next billing happens.

cancelledOninteger nullable

Timestamp of when the subscription was cancelled if applicable.

billingUnitstring nullable

The unit of billing. Example: "month"

cancelledReasonstring nullable
createdOninteger nullable
modifiedOninteger nullable
currentTermEndinteger nullable
EnabledFeaturesstring[] nullable

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.