Skip to main content
POST
/
subscriptions
Create a subscription
curl --request POST \
  --url https://api.rntor.com/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --data '
{
  "customer_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
  "billing_cycle": "monthly",
  "start_date": "2024-01-01",
  "total_amount": 299,
  "currency": "USD"
}
'
{
  "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

Body

application/json
billing_cycle
enum<string>
required
Available options:
monthly,
quarterly,
annually
start_date
string<date>
required
customer_id
string<uuid>

Either customer_id or company_id is required

company_id
string<uuid>

Either customer_id or company_id is required

end_date
string<date>
total_amount
number
currency
string

Response

Subscription created

data
object
meta
object