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

The Checkout object

Attributes

  • id

    stringoptional
    • Unique identifier for the object.

  • session_id

    stringoptional
    • Unique identifier for the Session.

  • status

    stringoptional
    • Checkout status. One ofstarted, completed

  • 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

    • amount_total

      numberoptional
      • Unit amount total for the Checkout.

    • amount_tax

      numberoptional
      • Unit amount tax for the Checkout.

    • amount_discount

      numberoptional
      • Unit amount discount for the Checkout.

    • amount_subtotal

      numberoptional
      • Unit amount subtotal for the Checkout. Any tax and discounts have not been subtrated from this amount.

    • mode

      enumoptional
      • The mode of the Checkout Session.

    • customer

      stringoptional
      • The ID of the customer for this Checkout.

    • email

      stringoptional
      • The Customer email used in the Checkout.

    • currency

      stringoptional
      • Currency for the checkout.

    • livemode

      booleanoptional
      • Has the valuetrueif the object exists inlivemode or the valuefalseif the object exists intestmode.
    More attributes
    Expand all

    • object

      stringstring value is "checkout"optional

    • subscription_id

      stringoptional

    • payment_intent_id

      stringoptional

    • client_reference_id

      stringoptional

    • payment_link_id

      stringoptional

    • payment_link_short_id

      stringoptional

    • page_id

      stringoptional

    • route

      stringoptional

    • ip

      stringoptional

    • os

      stringoptional

    • origin

      stringoptional

    • browser

      stringoptional

    • user_agent

      stringoptional

    • form_data

      Array of array of hashesoptional

    • device

      stringoptional

    • device_version

      stringoptional

    • fulfillment

      stringoptional

    • payment_type

      enumoptional

    • automatic_tax

      hashoptional

    • tax_id_collection

      hashoptional

    • payment_status

      enumoptional

    • payment_intent_capture_method

      enumoptional

    • adjustable_quantity_enabled

      booleanoptional

    • recovery_enabled

      booleanoptional

    • recovered_from

      stringoptional

    • shipping_options

      array of hashesoptional

    • shipping_rate

      stringoptional

    • tax_rates

      array of stringsoptional

    • coupons

      stringoptional

    • promotion_codes

      stringoptional

    • metadata

      hashoptional

    • created

      timestampoptional

    • trial_period_days

      numberoptional

    • updated

      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 Checkout object
    1
    {
    2
      "id": "07c432bf-cf5e-4900-a230-4e6de93d2bda",
    3
      "session_id": "cs_test_a1GuW4bP52ni9Si7PNx28wFi0Swi5sXR0tkKzaunIMIpp2nHAn5JGGaOwM",
    4
      "status": "started",
    5
      "line_items": [
    6
        {
    7
          "price": "price_123",
    8
          "product": "prod_123",
    9
          "currency": "usd",
    10
          "quantity": 1,
    11
          "recurring": null
    12
        }
    13
      ],
    14
      "form_data": [
    15
        [
    16
          {
    17
            "uid": "input",
    18
            "label": "User input",
    19
            "value": "The field value at the time of form submission."
    20
          }
    21
        ]
    22
      ],
    23
      "amount_total": 4750,
    24
      "amount_tax": 250,
    25
      "amount_discount": 5000,
    26
      "amount_subtotal": 7500,
    27
      "mode": "subscription",
    28
      "customer": null,
    29
      "email": null,
    30
      "currency": "usd",
    31
      "livemode": false,
    32
      "object": "checkout",
    33
      "subscription_id": null,
    34
      "payment_intent_id": "pi_123",
    35
      "client_reference_id": null,
    36
      "payment_link_id": "fbbfeb9a-be9b-4658-80ad-cdb47ff86fc3",
    37
      "payment_link_short_id": "YEZWSa8LjqGN5aPER7-Lw",
    38
      "page_id": null,
    39
      "route": null,
    40
      "ip": "127.0.0.1",
    41
      "os": "Mac OS X 10.15.7",
    42
      "origin": "https://priceblocs.com",
    43
      "browser": "Chrome",
    44
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
    45
      "device": "Other 0.0.0",
    46
      "device_version": "0.0.0",
    47
      "fulfillment": null,
    48
      "payment_type": "one_time",
    49
      "automatic_tax": false,
    50
      "tax_id_collection": false,
    51
      "payment_status": "unpaid",
    52
      "payment_intent_capture_method": "automatic",
    53
      "shipping_options": [
    54
        {
    55
          "shipping_rate": "shr_123"
    56
        },
    57
        {
    58
          "shipping_rate": "shr_456"
    59
        }
    60
      ],
    61
      "shipping_rate": "shr_456",
    62
      "tax_rates": "txr_123",
    63
      "coupons": "Ab8u1Zli",
    64
      "promotion_codes": null,
    65
      "trial_period_days": 14,
    66
      "metadata": null,
    67
      "adjustable_quantity_enabled": true,
    68
      "recovery_enabled": false,
    69
      "recovered_from": null,
    70
      "created": 1628958666,
    71
      "updated": 1628958666
    72
    }
    Show docs menu

    The Checkout object

    Attributes

    • id

      stringoptional
      • Unique identifier for the object.

    • session_id

      stringoptional
      • Unique identifier for the Session.

    • status

      stringoptional
      • Checkout status. One ofstarted, completed

    • 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

      • amount_total

        numberoptional
        • Unit amount total for the Checkout.

      • amount_tax

        numberoptional
        • Unit amount tax for the Checkout.

      • amount_discount

        numberoptional
        • Unit amount discount for the Checkout.

      • amount_subtotal

        numberoptional
        • Unit amount subtotal for the Checkout. Any tax and discounts have not been subtrated from this amount.

      • mode

        enumoptional
        • The mode of the Checkout Session.

      • customer

        stringoptional
        • The ID of the customer for this Checkout.

      • email

        stringoptional
        • The Customer email used in the Checkout.

      • currency

        stringoptional
        • Currency for the checkout.

      • livemode

        booleanoptional
        • Has the valuetrueif the object exists inlivemode or the valuefalseif the object exists intestmode.
      More attributes
      Expand all

      • object

        stringstring value is "checkout"optional

      • subscription_id

        stringoptional

      • payment_intent_id

        stringoptional

      • client_reference_id

        stringoptional

      • payment_link_id

        stringoptional

      • payment_link_short_id

        stringoptional

      • page_id

        stringoptional

      • route

        stringoptional

      • ip

        stringoptional

      • os

        stringoptional

      • origin

        stringoptional

      • browser

        stringoptional

      • user_agent

        stringoptional

      • form_data

        Array of array of hashesoptional

      • device

        stringoptional

      • device_version

        stringoptional

      • fulfillment

        stringoptional

      • payment_type

        enumoptional

      • automatic_tax

        hashoptional

      • tax_id_collection

        hashoptional

      • payment_status

        enumoptional

      • payment_intent_capture_method

        enumoptional

      • adjustable_quantity_enabled

        booleanoptional

      • recovery_enabled

        booleanoptional

      • recovered_from

        stringoptional

      • shipping_options

        array of hashesoptional

      • shipping_rate

        stringoptional

      • tax_rates

        array of stringsoptional

      • coupons

        stringoptional

      • promotion_codes

        stringoptional

      • metadata

        hashoptional

      • created

        timestampoptional

      • trial_period_days

        numberoptional

      • updated

        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 Checkout object
      1
      {
      2
        "id": "07c432bf-cf5e-4900-a230-4e6de93d2bda",
      3
        "session_id": "cs_test_a1GuW4bP52ni9Si7PNx28wFi0Swi5sXR0tkKzaunIMIpp2nHAn5JGGaOwM",
      4
        "status": "started",
      5
        "line_items": [
      6
          {
      7
            "price": "price_123",
      8
            "product": "prod_123",
      9
            "currency": "usd",
      10
            "quantity": 1,
      11
            "recurring": null
      12
          }
      13
        ],
      14
        "form_data": [
      15
          [
      16
            {
      17
              "uid": "input",
      18
              "label": "User input",
      19
              "value": "The field value at the time of form submission."
      20
            }
      21
          ]
      22
        ],
      23
        "amount_total": 4750,
      24
        "amount_tax": 250,
      25
        "amount_discount": 5000,
      26
        "amount_subtotal": 7500,
      27
        "mode": "subscription",
      28
        "customer": null,
      29
        "email": null,
      30
        "currency": "usd",
      31
        "livemode": false,
      32
        "object": "checkout",
      33
        "subscription_id": null,
      34
        "payment_intent_id": "pi_123",
      35
        "client_reference_id": null,
      36
        "payment_link_id": "fbbfeb9a-be9b-4658-80ad-cdb47ff86fc3",
      37
        "payment_link_short_id": "YEZWSa8LjqGN5aPER7-Lw",
      38
        "page_id": null,
      39
        "route": null,
      40
        "ip": "127.0.0.1",
      41
        "os": "Mac OS X 10.15.7",
      42
        "origin": "https://priceblocs.com",
      43
        "browser": "Chrome",
      44
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
      45
        "device": "Other 0.0.0",
      46
        "device_version": "0.0.0",
      47
        "fulfillment": null,
      48
        "payment_type": "one_time",
      49
        "automatic_tax": false,
      50
        "tax_id_collection": false,
      51
        "payment_status": "unpaid",
      52
        "payment_intent_capture_method": "automatic",
      53
        "shipping_options": [
      54
          {
      55
            "shipping_rate": "shr_123"
      56
          },
      57
          {
      58
            "shipping_rate": "shr_456"
      59
          }
      60
        ],
      61
        "shipping_rate": "shr_456",
      62
        "tax_rates": "txr_123",
      63
        "coupons": "Ab8u1Zli",
      64
        "promotion_codes": null,
      65
        "trial_period_days": 14,
      66
        "metadata": null,
      67
        "adjustable_quantity_enabled": true,
      68
        "recovery_enabled": false,
      69
        "recovered_from": null,
      70
        "created": 1628958666,
      71
        "updated": 1628958666
      72
      }