API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE

Update subscription

patch
https://api.sandbox.cleeng.com/3.1/subscriptions/

Use this endpoint to update an existing subscription, for example apply a coupon or to update payment details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

You can only use one parameter: expiresAt, couponCode, paymentDetailsId , status (deprecated), inTrial , externalProperties or subscriptionExternalId.

Response format is the same as in Create subscription endpoint.

Path Params
string
required

Subscription identifier at Cleeng.

Body Params
string
enum

Subscription status. Deprecated
To change subscription status, use the following endpoints:
- Activate subscription
- Cancel subscription
- Terminate subscription

Allowed:
string

Coupon code

int32

Expiration time in unix timestamp.

For Cleeng-managed subscriptions this value can't be in the past and it can't be earlier than the originally set value. (You can't shorten a Cleeng-managed subscription.)

For externally-managed subscriptions, these restrictions do not apply, and external systems that manage such subscriptions have full control over the expiration date.

int32

The identifier of Cleeng payment details connected to Cleeng customer. If you change this parameter, next renewals will be done with the new payment details ID.

boolean

Subscription trial status.

externalProperties
object
string

An external identifier of an externally-managed subscription.

  • Max length: 512 characters
  • Must not be empty string
  • Must be unique per customer and platform - cannot duplicate an external ID already used by another active, stopped or paused subscription of the same customer on the same platform (terminated subscriptions are not considered)
  • Nullable: no
Responses

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago