| Key | Type | Description |
|---|
| id | int | Numeric identifier |
| uuid | string | - Textual identifier
- 8 - 40 characters long
|
| status | string | The status of the subscription |
| start | string | The start date in the format 1970-01-01 |
| end | string|null | The end date in the format 1970-01-01 or null |
| valid_until | string|null | The next pay date in the format 1970-01-01 or null |
| paymentInterval | string | An interval specification like the duration parameter of DateInterval |
| invoice | Invoice | /pages/kiQvogNYjBqOH9n5kdI6 |
| contact | Contact | /pages/GsM9BSCi3Dw4KGhI4WBw |
| Status | Description |
|---|
| active | The subscription is active. Further charges are to come. |
| failed | The creation of the subscription failed, or a charge failed (status was overdue), and the retry failed as well. |
| cancelled | The subscription has been cancelled by the merchant, effective immediately. No more charges follow. |
| in_notice | The subscription has been cancelled by the shopper before the end date. The remaining charges will follow. |
| overdue | A charge failed. The subscription is tried to be charged again. After a second failure, the status changes to failed. |
{
"id": 1234,
"uuid": "aabb1122",
"status": "active",
"start": "2026-01-01",
"end": null,
"valid_until": "2026-12-31",
"paymentInterval": "P1M",
"invoice": {
"number": "Test",
"products": [
{
"name": "Test",
"description": "",
"price": 5000,
"quantity": 1,
"sku": null,
"vatRate": "8.10"
}
],
"discount": {
"code": null,
"amount": 0,
"percentage": null
},
"shippingAmount": null,
"currency": "CHF",
"test": 1,
"referenceId": "",
"purpose": "",
"paymentRequestId": null,
"paymentLink": null,
"googleAnalyticProducts": [
{
"item_id": 1324,
"item_name": "Test",
"price": 50,
"quantity": 1
}
],
"originalAmount": 5000,
"refundedAmount": 0,
"custom_fields": [
{
"type": "email",
"name": "Email",
"value": "subscription@test.com"
}
]
},
"contact": {
"id": 1234,
"uuid": "aabb1122",
"title": "female",
"firstname": "zahls.ch",
"lastname": "Test",
"company": "Company Name",
"street": "Burgstrasse 20",
"zip": "3600",
"place": "Thun",
"country": "",
"countryISO": "",
"phone": "0335500010",
"email": "subscription@test.com",
"date_of_birth": "01.01.1970",
"delivery_title": "",
"delivery_firstname": "",
"delivery_lastname": "",
"delivery_company": "",
"delivery_street": "",
"delivery_zip": "",
"delivery_place": "",
"delivery_country": "",
"delivery_countryISO": ""
}
}