Update a transaction

PATCH {{baseUrl}}/transactions/:transaction_id

Updates a transaction using its ID.

You can update transactions that are draft or ready. billed and completed transactions are considered records for tax and legal purposes, so they can't be changed. You can either:

• Create an adjustment to record a refund or credit for a transaction.
• Cancel a billed transaction by sending a PATCH request to set status to canceled.

The transaction status may only be set to billed or canceled. Other statuses are set automatically by Paddle. Set a manually-collected transaction to billed to mark it as finalized. This is essentially issuing an invoice. At this point, it becomes a legal record so you can't make changes to it. Paddle automatically assigns an invoice number, creates a related subscription, and sends it to your customer.

When making changes to items on a transaction, send the complete list of items that you'd like to be on a transaction — including existing items. For each item, send an object containing price_id and quantity. Paddle responds with the full price object for each item. See: Work with lists

If successful, your response includes a copy of the updated transaction entity.

Request Params

Request Body

{"status"=>"<string>", "customer_id"=>"<string>", "address_id"=>"<string>", "business_id"=>"<string>", "custom_data"=>"<object>", "currency_code"=>"<string>", "origin"=>"<string>", "collection_mode"=>"automatic", "discount_id"=>"<string>", "billing_details"=>{"enable_checkout"=>false, "purchase_order_number"=>"<string>", "additional_information"=>"<string,null>", "payment_terms"=>{"interval"=>"<string>", "frequency"=>"<integer>"}}, "billing_period"=>{"starts_at"=>"<dateTime>", "ends_at"=>"<dateTime>"}, "items"=>[{"price_id"=>"<string>", "quantity"=>"<integer>"}], "checkout"=>{"url"=>"<string,null>"}}

HEADERS