Sign in
api

post/api/credits/{credit_id}/void/

Path parameters

credit_idstring required

The ID of the credit to retrieve or update.

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

  • d246ebbb528d1See the full diff
    • ▲

      the response property customer/customer_id became nullable for the status 200

      response-property-became-nullable

  • 33a8ac13f9bf1See the full diff
    • ○

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

      response-property-pattern-removed

  • 3ce328fada4351See the full diff
    • ▲

      the response property amount_paid_currency became nullable for the status 200

      response-property-became-nullable

    • ▲

      the amount_paid_currency response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property amount_paid_currency/code from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property amount_paid_currency/name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property amount_paid_currency/symbol from the response with the 200 status

      response-required-property-removed

    • ○

      added PricingUnit to the amount_paid_currency response property allOf list for the response status 200

      response-property-all-of-added

  • 97264bb2115e1See the full diff
    • ○

      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

  • 36b48cae00a31See the full diff
    • ▲

      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