Update the subscription item to pause, resume or cancel its due payments.
Subscription with status canceled can't be updated.
These are the available values for the status parameter in the request body.
Only one header key is required for the request in the example below
PATCH https://api.sensepass.com/api/subscription/:subscriptionUid
available status values are: active, paused, canceled
Refer to the Subscritption entity at Subscription Model for additional information.
| status | description |
|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
active
default value that sets the subscription to active status
paused
pauses the subscription untill set back to active
canceled
canceles the subscription indefinitly
subscriptionUid
string
bf8b7e01-466d-4996-b9a2-fc0880923359.
subscription ID received from the Create a Transaction response
deviceId*
string
2ooeww5ufzg3nkuf8a10g15i5epu8o58jv1rznif3o1tr6xsb1rm
branchApiKey*
string
mQzMLLSpqjRZfWBgQcAej5Dus7HHvmRsSsrN6FYoeWWUAehm3RjD596pZb9gfrxx4jQOP2MCQgoLaaU9SAdlzVsWnR63ZETqALpn
merchantApiKey*
string
xvRKKxOWAYbTH2yKQLlzkta2eovvkzlzTW98NcA9KVfwrOF22GA7bBOHHAeooQrmKelv0TU3Q7c8wiJgTQweKCbXR5ohC6JtCygJ
status*
string
active,paused,canceled