Skip to main content
PATCH
/
subscriptions
/
{id}
Update a subscription
curl --request PATCH \
  --url https://api.rntor.com/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --data '
{
  "status": "paused",
  "payment_paused": true,
  "payment_paused_until": "2024-02-01T00:00:00Z"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing_cycle": "monthly",
    "start_date": "2024-01-01",
    "end_date": "2024-12-31",
    "status": "active",
    "total_amount": 299,
    "currency": "USD",
    "payment_paused": false,
    "payment_paused_until": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_abc123def456",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Your API client secret

​
X-Client-ID
string
header
required

Your API client ID

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
billing_cycle
enum<string>
Available options:
monthly,
quarterly,
annually
​
start_date
string<date>
​
end_date
string<date>
​
status
enum<string>
Available options:
active,
paused,
cancelled,
expired
​
total_amount
number
​
currency
string
​
payment_paused
boolean
​
payment_paused_until
string<date-time>

Response

Subscription updated

​
data
object
​
meta
object