• Pricing
  • Blog
Log inBook a demo
Create offer POSTDelete offer DELETEGet offer GETList offers GETUpdate offer PATCH
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

List offers

List reusable offer terms. Offers are independent from plans, prices, eligibility, and distribution channels.

GET
/offers

List reusable offer terms. Offers are independent from plans, prices, eligibility, and distribution channels.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

cursor?string
Length1 <= length
limit?integer
Range1 <= value <= 100
active?boolean

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/offers"
{  "object": "list",  "data": [    {      "id": "string",      "name": "string",      "phases": [        {          "type": "free_trial",          "durationDays": 1        }      ],      "metadata": {        "property1": null,        "property2": null      },      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "active": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "object": "offer",      "livemode": true    }  ],  "hasMore": true,  "nextCursor": "string"}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Get offer GET

Retrieve reusable offer terms by public ID.

Update offer PATCH

Replace reusable offer terms. Existing applications keep their immutable accepted terms.