ChangelogGuidesRecipesAPI ReferenceRoadmap
HomeGuidesRecipesAPI ReferenceChangelog
ChangelogGuidesRecipesAPI ReferenceRoadmapSTART FREE TRIALSCHEDULE A DEMO
API Reference
START FREE TRIALSCHEDULE A DEMO

Cancel subscription

post
https://www.pelcro.com/api/v1/sdk/subscription/cancel

Cancel an existing subscription for a customer on-session.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
int32
required

The unique identifier of the subscription to cancel.

string
enum
Defaults to last_period_end

Defines the cancellation mode, one of now, current_period_end or last_period_end. Choosing now will cancel it immediately and refund the prorated amount, if applicable. Default is to cancel at last_period_end.

Allowed:
string

The cancellation reason.

Headers
string
required
Defaults to Bearer eyJ***
string
Defaults to application/json
Responses

Updated about 1 month ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago