Delete credit grant

Use when removing or ending a credit grant (e.g. revoke promo or close prepaid). Plan-scoped grants are archived; subscription-scoped supports optional effective_date in body.

DELETE /creditgrants/{id}

Delete credit grant

cURL

curl --request DELETE \
  --url https://us.api.flexprice.io/v1/creditgrants/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "effective_date": "2023-11-07T05:31:56Z"
}
'

200

{
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Credit Grant ID

Body

application/json

Optional: effective_date for subscription-scoped grants

effective_date · string<date-time>

EffectiveDate is optional; when set (subscription scope) the grant end date is set to this time.

Response

200

application/json

OK

message · string