Update a credit note
POST / v1 / credit_notes /:id
Updates an existing credit note.
Parameters
- memo string Credit note memo.
- metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
Returns the updated credit note object if the call succeeded.
Response
Retrieve a credit note
GET / v1 / credit_notes /:id
Retrieves the credit note object with the given identifier.
Parameters
No parameters.
Returns
Returns a credit note object if a valid identifier was provided.
Response
Retrieve a credit note preview's line items
GET / v1 / credit_notes / preview / lines
When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
Parameters
- invoice string Required ID of the invoice.
- lines array of objects Required conditionally Line items that make up the credit note. One of
amount,lines, orshipping_costmust be provided. - memo string The credit note’s memo appears on the credit note PDF.
- metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - reason enum Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactoryPossible enum valuesduplicateCredit issued for a duplicate payment or chargefraudulentCredit note issued for fraudulent activityorder_changeCredit note issued for order changeproduct_unsatisfactoryCredit note issued for unsatisfactory product
More parameters
- amount integer Required conditionally
- credit _ amount integer
- effective _ at timestamp
- email _ type enum
- ending _ before string
- limit integer
- out _ of _ band _ amount integer
- refund _ amount integer
- refunds array of objects
- shipping _ cost object Required conditionally
- starting _ after string
Returns
Returns a list of line_item objects.
Response