PApaddlehq
Subscriptions

Get a transaction to update payment method

Changed on

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.

get/subscriptions/{subscription_id}/update-payment-method-transaction

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

subscription_idstring required

Paddle ID of the subscription entity to work with.

Response

The request has succeeded.

Changes

  • v1bbc0c72039c8Revision changes
    • info

      removed from the ///// response property oneOf list for the response status

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the ////////// response property oneOf list for the response status

    • breaking

      added to the //////// response property oneOf list for the response status

    • warning

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

    • info

      response property data/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/ deprecated

    • info

      response property data/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type deprecated

    • info

      response property data/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type/allOf[subschema #1: Korean market underlying payment method type]/ deprecated