Skip to main content
POST
/
v1
/
subscriptions
/
{subscription_id}
/
cancel
Cancel subscription
curl --request POST \
  --url https://api-sandbox.y.uno/v1/subscriptions/{subscription_id}/cancel \
  --header 'account-code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "ACTIVE",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "interval": "DAILY",
  "next_payment_date": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Calling this endpoint will cancel a subscription, changing its status to CANCELED. This change cannot be reverted back, being a final point for the respective subscription.

Authorizations

​
public-api-key
string
header
required

Your public API key from the Yuno Dashboard

​
private-secret-key
string
header
required

Your private secret key (server-side only)

​
account-code
string
header
required

Your account identifier. The alias X-Account-Code is also accepted.

Path Parameters

​
subscription_id
string<uuid>
required

The unique identifier of the subscription

Response

Subscription cancelled successfully

​
id
string<uuid>
​
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
PAST_DUE,
EXPIRED
​
amount
object
Example:
{ "currency": "BRL", "value": 100 }
​
interval
enum<string>
Available options:
DAILY,
WEEKLY,
MONTHLY,
YEARLY
​
next_payment_date
string<date-time>
​
created_at
string<date-time>
​
updated_at
string<date-time>