Retrieve payment link

Changed on

Retrieve a payment link.

get/v1/payment_links/{payment_link}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_links/{payment_link}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

payment_linkstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

activeboolean required

Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

allow_promotion_codesboolean required

Whether user redeemable promotion codes are enabled.

application_fee_amountinteger nullable

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.

application_fee_percentnumber nullable

This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.

billing_address_collection'auto' | 'required' required

Configuration for collecting the customer's billing address. Defaults to auto.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_creation'always' | 'if_required' required

Configuration for Customer creation during checkout.

idstring required

Unique identifier for the object.

inactive_messagestring nullable

The custom message to be displayed to a customer when a payment link is no longer active.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'payment_link' required

String representing the object's type. Objects of the same type share the same value.

payment_method_collection'always' | 'if_required' required

Configuration for collecting a payment method during checkout. Defaults to always.

payment_method_typesstring[] nullable

The list of payment method types that customers can use. When null, Stripe will dynamically show relevant payment methods you've enabled in your payment method settings.

submit_type'auto' | 'book' | 'donate' | 'pay' | 'subscribe' required

Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.

urlstring required

The public URL that can be shared with customers.

Changes

  • 585b581504aeRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • 7537419124b6Revision changes
    • info

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

    • info

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

Some revisions have not been checked yet.