Credit Grants

Delete credit grant

Changed on

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}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/creditgrants/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Credit Grant ID

Request body

effective_datestring date-time

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

Response

OK

messagestring

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 646d6658479bRevision changes
    • breaking

      the request property format changed from no format to date-time