Get a transaction to update payment method

Permission required

gethttps://api.paddle.com/subscriptions/{subscription_id}/update-payment-method-transaction

Returns a transaction that you can pass to a checkout to let customers update their payment details. Only for subscriptions where collection_mode is automatic.

The transaction returned depends on the status of the related subscription:

Where a subscription is past_due, it returns the most recent past_due transaction.
Where a subscription is active, it creates a new zero amount transaction for the items on a subscription.

You can use the returned checkout.url, or pass the returned transaction ID to Paddle.js to open a checkout to present customers with a way of updating their payment details.

The customer, address, business, discount, adjustments and adjustments_totals properties are only returned in the response if the API key has read permissions for those related entities.

Path Parameters

subscription_idstringrequired

Paddle ID of the subscription entity to work with.

Response

dataobject

Represents a transaction entity.

idstring

Unique Paddle ID for this transaction entity, prefixed with txn_.

statusstring

Status of this transaction. You may set a transaction to billed or canceled, other statuses are set automatically by Paddle. Automatically-collected transactions may return completed if payment is captured successfully, or past_due if payment failed.

customer_idstring or null

Paddle ID of the customer that this transaction is for, prefixed with ctm_.

address_idstring or null

Paddle ID of the address that this transaction is for, prefixed with add_.

business_idstring or null

Paddle ID of the business that this transaction is for, prefixed with biz_.

custom_dataobject or null

Your own structured key-value data.

currency_codestring

Supported three-letter ISO 4217 currency code. Must be USD, EUR, or GBP if collection_mode is manual.

originstring

Describes how this transaction was created.

subscription_idstring or null

Paddle ID of the subscription that this transaction is for, prefixed with sub_.

invoice_idstring or nullDeprecated

Paddle ID of the invoice that this transaction is related to, prefixed with inv_. Used for compatibility with the Paddle Invoice API, which is now deprecated. This field is scheduled to be removed in the next version of the Paddle API.

invoice_numberstring or null

Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as billed where collection_mode is manual.

collection_modestring

How payment is collected for this transaction. automatic for checkout, manual for invoices.

discount_idstring or null

Paddle ID of the discount applied to this transaction, prefixed with dsc_.

billing_detailsobject or null

Details for invoicing. Required if collection_mode is manual.

billing_periodobject or null

Time period that this transaction is for. Set automatically by Paddle for subscription renewals to describe the period that charges are for.

itemsarray[object]

List of items on this transaction. For calculated totals, use details.line_items.

detailsobject

Calculated totals for a transaction, including proration, discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction.

paymentsarray[object]

List of payment attempts for this transaction, including successful payments. Sorted by created_at in descending order, so most recent attempts are returned first.

checkoutobject or null

Paddle Checkout details for this transaction. Returned for automatically-collected transactions and where billing_details.enable_checkout is true for manually-collected transactions; null otherwise.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

billed_atstring<date-time> or null

RFC 3339 datetime string of when this transaction was marked as billed. null for transactions that aren't billed or completed. Set automatically by Paddle.

revised_atstring<date-time> or null

RFC 3339 datetime string of when a transaction was revised. Revisions describe an update to customer information for a billed or completed transaction. null if not revised. Set automatically by Paddle.

customerobject

Related customer for this transaction. Only returned if the API key has a Customers (Read) permission.

addressobject

Related address for this transaction. Only returned if the API key has an Addresses (Read) permission.

businessobject

Related business for this transaction. Only returned if a business exists for this transaction and the API key has a Businesses (Read) permission.

discountobject

Related discount for this transaction. Only returned if a discount exists for this transaction and the API key has a Discounts (Read) permission.

adjustmentsarray[object]

Related adjustments for this transaction. Only returned if adjustments exist for this transaction and the API key has an Adjustments (Read) permission.

adjustments_totalsobject

Object containing totals for all adjustments on this transaction. Only returned if the API key has an Adjustments (Read) permission.

available_payment_methodsarray[string]

List of payment methods available for this transaction.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

Response

AI AssistantBeta

Ask a question to start a conversation!

If you have made a purchase through Paddle, go to paddle.net instead.

Protected by hCaptcha