Subscriptions
Recurring billing. Create a subscription, query its status, or cancel it. Retries and email notifications are handled for you.
A Subscription represents a recurring agreement to charge a customer on a fixed interval. The lifecycle moves through created → pending → active → past_due → cancelled — see Concepts → Subscriptions for the full state machine and the retry schedule.
Create a subscription
Create a subscription.
Authentication: Basic Auth (public_key:secret_key) with merchant role.
In: header
Response Body
application/json
application/json
curl -X POST "https://sandbox.mintcash.me/subscriptions" \ -H "Content-Type: application/json" \ -d '{ "amount": 0, "billingIntervalDays": 0, "currency": "string", "externalId": "string" }'{
"amount": 0,
"billingIntervalDays": 0,
"createdAt": "string",
"currency": "string",
"currentPeriodEnd": "string",
"currentPeriodStart": "string",
"externalId": "string",
"id": "string",
"redirectUrl": "string",
"status": "string"
}{
"code": "not_found",
"details": {},
"message": "string"
}Retrieve a subscription
Get a subscription by ID.
Authentication: Basic Auth (public_key:secret_key) with merchant role.
In: header
Path Parameters
Response Body
application/json
application/json
curl -X GET "https://sandbox.mintcash.me/subscriptions/string"{
"amount": 0,
"billingIntervalDays": 0,
"createdAt": "string",
"currency": "string",
"currentPeriodEnd": "string",
"currentPeriodStart": "string",
"externalId": "string",
"id": "string",
"redirectUrl": "string",
"status": "string"
}{
"code": "not_found",
"details": {},
"message": "string"
}Cancel a subscription
Cancellation is immediate and irreversible. Pending invoices are not charged.
Cancel an active or past_due subscription.
Cancellation is immediate. The subscription will not renew. The current period remains valid (no prorated refund at MVP).
Authentication: Basic Auth (public_key:secret_key) with merchant role.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/json
curl -X DELETE "https://sandbox.mintcash.me/subscriptions/string"{
"amount": 0,
"billingIntervalDays": 0,
"createdAt": "string",
"currency": "string",
"currentPeriodEnd": "string",
"currentPeriodStart": "string",
"externalId": "string",
"id": "string",
"redirectUrl": "string",
"status": "string"
}{
"code": "not_found",
"details": {},
"message": "string"
}