PriceBlocs Logo
v1.0.0
Search
⌘K
Join us on Discord

The payment link object

Attributes

  • id

    stringoptional
    • Unique identifier for the object.

  • short_id

    stringoptional
    • Unique short identifier for the object.

  • url

    stringoptional
    • URL to initiate a new checkout sesion.

  • brand_url

    stringoptional
    • Branded version of the URL. For Organization accounts, the standard url will be prefixed with a subdomain for the connected Stripe account url, for User accounts, the url will be suffixed with the chosen account alias.

  • line_items

    Array of hashesoptional
    • The line items purchased by the customer. Will not be present when the checkout session is insetupmode.
      Show child attributes

    • currency

      stringoptional
      • Currency for the payment link.

    • status

      stringoptional
      • Current Payment Link status. One ofactive, inactive, archived

    • success_url

      stringoptional
      • The URL the customer will be directed to when payment or setup is complete. This url will automatically have the Checkoutsession_idappended to it. By default, this URL will be the standard PriceBlocs checkout complete success page. This value cannot be set dynamically via query string param.Learn more about default redirect urlshere.

    • cancel_url

      stringoptional
      • The URL the customer will be directed to if they decide to cancel the active Checkout Session. By default this will be the account profile url of the connected Stripe account, otherwise it will be the stanard PriceBlocs checkout error page. Can be set dynamically via query string param.Learn more about default redirect urlshere.

    • customer

      stringoptional
      • The ID of the customer for this Session. For Checkout Sessions inpaymentorsubscriptionmode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.

    • email

      stringoptional
      • The Customer email used to create the checkout session with.
    More attributes
    Expand all

    • object

      stringstring value is "payment_link"optional

    • mode

      enumoptional

    • title

      stringoptional

    • description

      stringoptional

    • livemode

      booleanoptional

    • payment_method_types

      array containing stringsoptional

    • discounts

      array containing hashesoptional

    • billing_address_collection

      enumoptional

    • shipping_worldwide

      booleanoptional

    • shipping_address_collection

      hashoptional

    • shipping_options

      array of hashesoptional

    • consent_collection

      hashoptional

    • after_expiration

      hashoptional

    • expires_at

      numberoptional

    • submit_type

      enumoptional

    • allow_promotion_codes

      booleanoptional

    • adjustable_quantity

      hashoptional

    • tax_rates

      array of stringsoptional

    • dynamic_tax_rates

      array of stringsoptional

    • automatic_tax

      hashoptional

    • tax_id_collection

      hashoptional

    • payment_intent_data

      hashoptional

    • trial_period_days

      numberoptional

    • trial_end

      timestampoptional
    Have any questions or feedback?
    or join us on Discord
    Get API keys
    Sign up to get access to your own API keys.
    The payment link object
    1
    {
    2
      "url": "https://priceblocs.com/test/links/short_id",
    3
      "brand_url": "https://priceblocs.com/test/links/short_id",
    4
      "livemode": false,
    5
      "id": "00000000-0000-0000-0000-000000000000",
    6
      "object": "payment_link",
    7
      "short_id": "short_id",
    8
      "title": "My first payment link",
    9
      "description": "Each link will start a new checkout session when clicked",
    10
      "success_url": "https://priceblocs.com/checkout/success",
    11
      "cancel_url": "https://priceblocs.com/checkout/error",
    12
      "created": 1628234366,
    13
      "updated": 1628234366,
    14
      "payment_method_types": [
    15
        "card"
    16
      ],
    17
      "currency": "usd",
    18
      "customer_email": "someone@gmail.com",
    19
      "customer": null,
    20
      "status": "active",
    21
      "discounts": [
    22
        {
    23
          "coupon": "coupon123"
    24
        }
    25
      ],
    26
      "billing_address_collection": "auto",
    27
      "shipping_address_collection": {
    28
        "allowed_countries": [
    29
          "US"
    30
        ]
    31
      },
    32
      "mode": "subscription",
    33
      "submit_type": "pay",
    34
      "allow_promotion_codes": false,
    35
      "adjustable_quantity": {
    36
        "enabled": true,
    37
        "maximum": 99,
    38
        "minimum": 1
    39
      },
    40
      "shipping_worldwide": false,
    41
      "tax_rates": [
    42
        "txr_123"
    43
      ],
    44
      "dynamic_tax_rates": [
    45
        "txr_456"
    46
      ],
    47
      "automatic_tax": {
    48
        "enabled": true
    49
      },
    50
      "tax_id_collection": {
    51
        "enabled": false,
    52
        "type": "standard"
    53
      },
    54
      "consent_collection": {
    55
        "promotions": "auto"
    56
      },
    57
      "after_expiration": {
    58
        "recovery": {
    59
          "enabled": true,
    60
          "allow_promotion_codes": true
    61
        }
    62
      },
    63
      "expires_at": 1628234366,
    64
      "shipping_options": [
    65
        {
    66
          "shipping_rate": "shr_456"
    67
        }
    68
      ],
    69
      "payment_intent_data": {
    70
        "capture_method": "automatic",
    71
        "transfer_data": {
    72
          "destination": "act_123"
    73
        }
    74
      },
    75
      "trial_period_days": null,
    76
      "trial_end": null,
    77
      "line_items": [
    78
        {
    79
          "price": "p_A_1",
    80
          "product": "p_A",
    81
          "currency": "usd",
    82
          "interval": "month",
    83
          "quantity": 1,
    84
          "dynamic_tax_rates": null,
    85
          "tax_rates": null
    86
        }
    87
      ]
    88
    }
    Show docs menu

    The payment link object

    Attributes

    • id

      stringoptional
      • Unique identifier for the object.

    • short_id

      stringoptional
      • Unique short identifier for the object.

    • url

      stringoptional
      • URL to initiate a new checkout sesion.

    • brand_url

      stringoptional
      • Branded version of the URL. For Organization accounts, the standard url will be prefixed with a subdomain for the connected Stripe account url, for User accounts, the url will be suffixed with the chosen account alias.

    • line_items

      Array of hashesoptional
      • The line items purchased by the customer. Will not be present when the checkout session is insetupmode.
        Show child attributes

      • currency

        stringoptional
        • Currency for the payment link.

      • status

        stringoptional
        • Current Payment Link status. One ofactive, inactive, archived

      • success_url

        stringoptional
        • The URL the customer will be directed to when payment or setup is complete. This url will automatically have the Checkoutsession_idappended to it. By default, this URL will be the standard PriceBlocs checkout complete success page. This value cannot be set dynamically via query string param.Learn more about default redirect urlshere.

      • cancel_url

        stringoptional
        • The URL the customer will be directed to if they decide to cancel the active Checkout Session. By default this will be the account profile url of the connected Stripe account, otherwise it will be the stanard PriceBlocs checkout error page. Can be set dynamically via query string param.Learn more about default redirect urlshere.

      • customer

        stringoptional
        • The ID of the customer for this Session. For Checkout Sessions inpaymentorsubscriptionmode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.

      • email

        stringoptional
        • The Customer email used to create the checkout session with.
      More attributes
      Expand all

      • object

        stringstring value is "payment_link"optional

      • mode

        enumoptional

      • title

        stringoptional

      • description

        stringoptional

      • livemode

        booleanoptional

      • payment_method_types

        array containing stringsoptional

      • discounts

        array containing hashesoptional

      • billing_address_collection

        enumoptional

      • shipping_worldwide

        booleanoptional

      • shipping_address_collection

        hashoptional

      • shipping_options

        array of hashesoptional

      • consent_collection

        hashoptional

      • after_expiration

        hashoptional

      • expires_at

        numberoptional

      • submit_type

        enumoptional

      • allow_promotion_codes

        booleanoptional

      • adjustable_quantity

        hashoptional

      • tax_rates

        array of stringsoptional

      • dynamic_tax_rates

        array of stringsoptional

      • automatic_tax

        hashoptional

      • tax_id_collection

        hashoptional

      • payment_intent_data

        hashoptional

      • trial_period_days

        numberoptional

      • trial_end

        timestampoptional
      Have any questions or feedback?
      or join us on Discord
      Get API keys
      Sign up to get access to your own API keys.
      The payment link object
      1
      {
      2
        "url": "https://priceblocs.com/test/links/short_id",
      3
        "brand_url": "https://priceblocs.com/test/links/short_id",
      4
        "livemode": false,
      5
        "id": "00000000-0000-0000-0000-000000000000",
      6
        "object": "payment_link",
      7
        "short_id": "short_id",
      8
        "title": "My first payment link",
      9
        "description": "Each link will start a new checkout session when clicked",
      10
        "success_url": "https://priceblocs.com/checkout/success",
      11
        "cancel_url": "https://priceblocs.com/checkout/error",
      12
        "created": 1628234366,
      13
        "updated": 1628234366,
      14
        "payment_method_types": [
      15
          "card"
      16
        ],
      17
        "currency": "usd",
      18
        "customer_email": "someone@gmail.com",
      19
        "customer": null,
      20
        "status": "active",
      21
        "discounts": [
      22
          {
      23
            "coupon": "coupon123"
      24
          }
      25
        ],
      26
        "billing_address_collection": "auto",
      27
        "shipping_address_collection": {
      28
          "allowed_countries": [
      29
            "US"
      30
          ]
      31
        },
      32
        "mode": "subscription",
      33
        "submit_type": "pay",
      34
        "allow_promotion_codes": false,
      35
        "adjustable_quantity": {
      36
          "enabled": true,
      37
          "maximum": 99,
      38
          "minimum": 1
      39
        },
      40
        "shipping_worldwide": false,
      41
        "tax_rates": [
      42
          "txr_123"
      43
        ],
      44
        "dynamic_tax_rates": [
      45
          "txr_456"
      46
        ],
      47
        "automatic_tax": {
      48
          "enabled": true
      49
        },
      50
        "tax_id_collection": {
      51
          "enabled": false,
      52
          "type": "standard"
      53
        },
      54
        "consent_collection": {
      55
          "promotions": "auto"
      56
        },
      57
        "after_expiration": {
      58
          "recovery": {
      59
            "enabled": true,
      60
            "allow_promotion_codes": true
      61
          }
      62
        },
      63
        "expires_at": 1628234366,
      64
        "shipping_options": [
      65
          {
      66
            "shipping_rate": "shr_456"
      67
          }
      68
        ],
      69
        "payment_intent_data": {
      70
          "capture_method": "automatic",
      71
          "transfer_data": {
      72
            "destination": "act_123"
      73
          }
      74
        },
      75
        "trial_period_days": null,
      76
        "trial_end": null,
      77
        "line_items": [
      78
          {
      79
            "price": "p_A_1",
      80
            "product": "p_A",
      81
            "currency": "usd",
      82
            "interval": "month",
      83
            "quantity": 1,
      84
            "dynamic_tax_rates": null,
      85
            "tax_rates": null
      86
          }
      87
        ]
      88
      }