Credit Notes

Create credit note

Changed on

Use when issuing a refund or adjustment (e.g. customer dispute or proration). Links to an invoice; create as draft then finalize.

post/creditnotes

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/creditnotes
  • Auth
    • API key in header x-api-key
    • or API key in header x-api-key

Request body

credit_note_numberstring

credit_note_number is an optional human-readable identifier for the credit note

idempotency_keystring

idempotency_key is an optional key used to prevent duplicate credit note creation

invoice_idstring required

invoice_id is the unique identifier of the invoice this credit note is applied to

memostring

memo is an optional free-text field for additional notes about the credit note

metadataTypesMetadata
process_credit_noteboolean

process_credit_note is a flag to process the credit note after creation

reason'DUPLICATE' | 'FRAUDULENT' | 'ORDER_CHANGE' | 'UNSATISFACTORY' | 'SERVICE_ISSUE' | 'BILLING_ERROR' | 'SUBSCRIPTION_CANCELLATION' required
refund_target'PREPAID_WALLET' | 'BACK_TO_SOURCE'

Response

Created

created_atstring date-time
created_bystring
credit_note_numberstring

credit_note_number is the unique identifier for credit notes

credit_note_status'DRAFT' | 'FINALIZED' | 'VOIDED'
credit_note_type'ADJUSTMENT' | 'REFUND'
currencystring

currency is the three-letter ISO currency code (e.g., USD, EUR) for the credit note

customer_idstring

customer_id is the unique identifier of the customer who owns this credit note

environment_idstring

environment_id is the unique identifier of the environment this credit note belongs to

finalized_atstring date-time

finalized_at is the timestamp when the credit note was finalized

idstring

id is the unique identifier for the credit note

idempotency_keystring

idempotency_key is an optional key used to prevent duplicate credit note creation

invoice_idstring

invoice_id is the id of the invoice resource that this credit note is applied to

memostring

memo is an optional memo supplied on the credit note

metadataTypesMetadata
reason'DUPLICATE' | 'FRAUDULENT' | 'ORDER_CHANGE' | 'UNSATISFACTORY' | 'SERVICE_ISSUE' | 'BILLING_ERROR' | 'SUBSCRIPTION_CANCELLATION'
refund_status'INITIATED' | 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'OVERPAID' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'VOIDED'
status'published' | 'deleted' | 'archived'
subscription_idstring

subscription_id is the optional unique identifier of the subscription related to this credit note

tenant_idstring
total_amountstring

total_amount is the total including creditable invoice-level discounts or minimums, and tax

updated_atstring date-time
updated_bystring
voided_atstring date-time

voided_at is the timestamp when the credit note was voided

Changes

  • 84cb4a3af400Revision changes
    • info

      added the optional property / to the response with the status

  • 3798546cc4a3Revision changes
    • warning

      added the new END_OF_MONTH enum value to the // response property for the response status

    • warning

      added the new END_OF_MONTH enum value to the / response property for the response status

    • warning

      added the new END_OF_NEXT_MONTH enum value to the // response property for the response status

    • warning

      added the new END_OF_NEXT_MONTH enum value to the / response property for the response status

    • warning

      added the new credit_note enum value to the /// response property for the response status

    • warning

      added the new not_collecting enum value to the / response property for the response status

    • warning

      added the new not_collecting enum value to the /// response property for the response status

    • warning

      added the new not_subject_to_tax enum value to the / response property for the response status

    • warning

      added the new not_subject_to_tax enum value to the /// response property for the response status

    • warning

      added the new not_supported enum value to the / response property for the response status

    • warning

      added the new not_supported enum value to the /// response property for the response status

    • warning

      added the new reverse_charge enum value to the / response property for the response status

    • warning

      added the new reverse_charge enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status