api

post/api/credits/{credit_id}/update/

Path parameters

credit_idstring required

The ID of the credit to retrieve or update.

Request body

descriptionstring nullable
expires_atstring date-time nullable

Response

credit_idstring required
amountnumber double required
amount_remainingnumber double required
descriptionstring nullable required
effective_atstring date-time required
expires_atstring date-time nullable required
status'active' | 'inactive' required
  • active - Active
  • inactive - Inactive
amount_paidnumber double required

Changes

Changed in 5 of the 50 revisions of this API.73

    • the response property / became nullable for the status

      response-property-became-nullable

    • the / response's property pattern ^[-a-zA-Z0-9_]+$ was removed for the status

      response-property-pattern-removed

  • 3ce328fada4351See the full diff
    • the response property became nullable for the status

      response-property-became-nullable

    • the response's property type changed from object to no type for status

      response-property-type-changed

    • removed the required property / from the response with the status

      response-required-property-removed

    • removed the required property / from the response with the status

      response-required-property-removed

    • removed the required property / from the response with the status

      response-required-property-removed

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 145 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog