• Pricing
  • Blog
Log inBook a demo
Batch create customers POSTGrant customer credit POSTCreate customer POSTGet customer GETList customer credits GETList customers GETRevoke remaining customer credit POSTUpdate customer PATCH
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Revoke remaining customer credit

Revoke the unallocated remainder of a customer credit grant. Applied invoice history is unchanged.

POST
/customers/{id}/credits/{creditId}/revoke

Revoke the unallocated remainder of a customer credit grant. Applied invoice history is unchanged.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string
creditId*string

Header Parameters

Idempotency-Key?string

Unique key used to safely retry this write for 24 hours without applying it twice.

Length1 <= length <= 200

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers/string/credits/string/revoke"
{  "id": "string",  "remainingAmount": -9007199254740991,  "revokedAmount": -9007199254740991,  "currency": "string",  "object": "customer_credit",  "livemode": true}
{  "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"  }}
{  "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"  }}

List customers GET

List customers with cursor-based pagination.

Update customer PATCH

Update a customer's name, external ID, or metadata.