Retrieve a promo code by its public ID.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/promo-codes/string"

{  "success": true,  "data": {    "id": "string",    "code": "string",    "discountType": "percentage",    "discountValue": -9007199254740991,    "durationCycles": -9007199254740991,    "maxRedemptions": -9007199254740991,    "expiresAt": "2019-08-24T14:15:22Z",    "isActive": true,    "redemptionCount": -9007199254740991,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "object": "promo_code",    "livemode": true  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Get promo code

Authorization

Path Parameters

Response Body

200application/json

400application/json

401application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`