# Retrieve a Checkout Session's line items ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/checkout/sessions/{id}/line_items: get: summary: Retrieve a Checkout Session's line items deprecated: false description: '' tags: - API Reference/Checkout parameters: - name: id in: path description: '' required: true schema: type: string - name: Accept in: header description: '' required: true example: application/json schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object x-apifox-refs: 01GMQNWCK8783BHZABDXAZWTGX: $ref: '#/components/schemas/List%20Request' x-apifox-overrides: created: null x-apifox-orders: - 01GMQNWCK8783BHZABDXAZWTGX properties: ending_before: type: string description: >- A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. limit: type: integer description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. starting_after: type: string description: >- A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. x-apifox-ignore-properties: - ending_before - limit - starting_after responses: '200': description: '' content: application/json: schema: type: object x-apifox-refs: 01GMQNWR2J21Z20V1ZK7GKC9DN: $ref: '#/components/schemas/List' x-apifox-overrides: data: &ref_0 type: array items: type: object x-apifox-refs: 01GMQNX2MZWB94HZNGV67MXD9J: $ref: '#/components/schemas/item' x-apifox-overrides: amount_tax: null amount_discount: null discounts: null taxes: null x-apifox-orders: - 01GMQNX2MZWB94HZNGV67MXD9J properties: id: type: string description: Unique identifier for the object, like "li_xxx" object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. amount_subtotal: type: string description: Total before any discounts or taxes are applied. amount_total: type: string description: Total after discounts and taxes. currency: type: string description: Three-letter ISO currency code. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. price: type: object x-apifox-refs: 01GMQG5R25JKZG1CEB31ZYK9A1: &ref_1 $ref: '#/components/schemas/Price' x-apifox-overrides: custom_unit_amount: null tax_behavior: null tiers_mode: null transform_quantity: null unit_amount_decimal: null x-apifox-orders: - 01GMQG5R25JKZG1CEB31ZYK9A1 properties: id: type: string description: >- Unique identifier for the object, like "price_xxxx". object: type: string description: '''price''' active: type: boolean description: >- Whether the price can be used for new purchases. billing_scheme: type: string description: >- Describes how to compute the price per period. Either per_unit or tiered enum: - per_unit - tiered x-apifox-enum: - value: per_unit name: '' description: only per_unit is supported now. - value: tiered name: '' description: '' created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. currency: type: string description: >- Three-letter ISO currency code, in uppercase. livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. lookup_key: type: string description: >- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. metadata: type: object properties: {} x-apifox-orders: [] description: >- 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. x-apifox-ignore-properties: [] nickname: type: string description: >- A brief description of the price, hidden from customers. product: type: string description: >- The ID of the product this price is associated with. type: type: string description: >- One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. enum: - one_time - recurring x-apifox-enum: - value: one_time name: '' description: only one-time is supported now. - value: recurring name: '' description: '' unit_amount: type: integer description: >- The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. recurring: type: object properties: interval: type: string description: >- The frequency at which a subscription is billed. One of day, week, month or year. enum: - day - week - month - year x-apifox-enum: - value: day name: '' description: '' - value: week name: '' description: '' - value: month name: '' description: '' - value: year name: '' description: '' interval_count: type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. usage_type: type: string description: >- Configures how the quantity per period should be determined. enum: - licensed x-apifox-enum: - value: licensed name: '' description: '' x-apifox-orders: - interval - interval_count - usage_type description: The recurring components of a price required: - interval x-apifox-ignore-properties: [] tiers: type: array items: type: object properties: up_to: type: string description: >- Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier. flat_amount: type: string description: >- The flat billing amount for an entire tier, regardless of the number of units in the tier. unit_amount: type: string description: >- The per unit billing amount for each individual unit for which this tier applies. x-apifox-orders: - up_to - flat_amount - unit_amount x-apifox-ignore-properties: [] description: （未实现） description: The price used to generate the line item. x-apifox-ignore-properties: - id - object - active - billing_scheme - created - currency - livemode - lookup_key - metadata - nickname - product - type - unit_amount - recurring - tiers quantity: type: string description: The quantity of products being purchased. x-apifox-ignore-properties: - id - object - amount_subtotal - amount_total - currency - description - price - quantity required: [] x-apifox-orders: - 01GMQNWR2J21Z20V1ZK7GKC9DN properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: *ref_0 x-apifox-ignore-properties: - object - url - has_more - data headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Checkout x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-42654204-run components: schemas: List Request: type: object properties: created: type: object properties: gt: type: string description: >- Return results where the created field is greater than this value. gte: type: string description: >- Return results where the created field is greater than or equal to this value. lt: type: string description: Return results where the created field is less than this value. lte: type: string description: >- Return results where the created field is less than or equal to this value. description: >- A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: x-apifox-orders: - gt - gte - lt - lte x-apifox-ignore-properties: [] ending_before: type: string description: >- A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. limit: type: integer description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. starting_after: type: string description: >- A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. x-apifox-orders: - created - ending_before - limit - starting_after x-apifox-ignore-properties: [] x-apifox-folder: '' List: type: object properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: type: array items: type: object properties: id: type: string object: type: string api_version: type: 'null' application: type: 'null' created: type: integer description: type: string enabled_events: type: array items: type: string livemode: type: boolean metadata: type: object properties: {} x-apifox-orders: [] x-apifox-ignore-properties: [] status: type: string url: type: string x-apifox-orders: - id - object - api_version - application - created - description - enabled_events - livemode - metadata - status - url x-apifox-ignore-properties: [] x-apifox-orders: - object - url - has_more - data x-apifox-ignore-properties: [] x-apifox-folder: '' Price: type: object properties: id: &ref_2 type: string description: Unique identifier for the object, like "price_xxxx". object: &ref_3 type: string description: '''price''' active: &ref_4 type: boolean description: Whether the price can be used for new purchases. billing_scheme: type: string description: >- Describes how to compute the price per period. Either per_unit or tiered enum: &ref_5 - per_unit - tiered x-apifox-enum: - value: per_unit name: '' description: only per_unit is supported now. - value: tiered name: '' description: '' created: &ref_6 type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. currency: &ref_7 type: string description: 'Three-letter ISO currency code, in uppercase. ' livemode: &ref_8 type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. lookup_key: &ref_9 type: string description: >- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. metadata: type: object properties: {} x-apifox-orders: &ref_10 [] description: >- 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. x-apifox-ignore-properties: [] nickname: &ref_11 type: string description: A brief description of the price, hidden from customers. product: &ref_12 type: string description: The ID of the product this price is associated with. type: type: string description: >- One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. enum: &ref_13 - one_time - recurring x-apifox-enum: - value: one_time name: '' description: only one-time is supported now. - value: recurring name: '' description: '' unit_amount: &ref_14 type: integer description: >- The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. custom_unit_amount: type: 'null' description: （未实现） recurring: type: object properties: interval: type: string description: >- The frequency at which a subscription is billed. One of day, week, month or year. enum: &ref_15 - day - week - month - year x-apifox-enum: - value: day name: '' description: '' - value: week name: '' description: '' - value: month name: '' description: '' - value: year name: '' description: '' interval_count: &ref_16 type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. usage_type: type: string description: Configures how the quantity per period should be determined. enum: &ref_17 - licensed x-apifox-enum: - value: licensed name: '' description: '' x-apifox-orders: &ref_18 - interval - interval_count - usage_type description: The recurring components of a price required: - interval x-apifox-ignore-properties: [] tax_behavior: type: string description: （未实现） tiers_mode: type: 'null' description: （未实现） tiers: type: array items: type: object properties: up_to: &ref_19 type: string description: >- Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier. flat_amount: &ref_20 type: string description: >- The flat billing amount for an entire tier, regardless of the number of units in the tier. unit_amount: &ref_21 type: string description: >- The per unit billing amount for each individual unit for which this tier applies. x-apifox-orders: &ref_22 - up_to - flat_amount - unit_amount x-apifox-ignore-properties: [] description: （未实现） transform_quantity: type: 'null' description: （未实现） unit_amount_decimal: type: string description: （未实现） x-apifox-orders: - id - object - active - billing_scheme - created - currency - livemode - lookup_key - metadata - nickname - product - type - unit_amount - custom_unit_amount - recurring - tax_behavior - tiers_mode - tiers - transform_quantity - unit_amount_decimal x-apifox-ignore-properties: [] x-apifox-folder: '' item: type: object properties: id: type: string description: Unique identifier for the object, like "li_xxx" object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. amount_subtotal: type: string description: Total before any discounts or taxes are applied. amount_total: type: string description: Total after discounts and taxes. currency: type: string description: Three-letter ISO currency code. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. price: type: object x-apifox-refs: 01GMQG5R25JKZG1CEB31ZYK9A1: *ref_1 x-apifox-orders: - 01GMQG5R25JKZG1CEB31ZYK9A1 properties: id: *ref_2 object: *ref_3 active: *ref_4 billing_scheme: type: string description: >- Describes how to compute the price per period. Either per_unit or tiered enum: *ref_5 x-apifox-enum: - value: per_unit name: '' description: only per_unit is supported now. - value: tiered name: '' description: '' created: *ref_6 currency: *ref_7 livemode: *ref_8 lookup_key: *ref_9 metadata: type: object properties: {} x-apifox-orders: *ref_10 description: >- 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. x-apifox-ignore-properties: [] nickname: *ref_11 product: *ref_12 type: type: string description: >- One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. enum: *ref_13 x-apifox-enum: - value: one_time name: '' description: only one-time is supported now. - value: recurring name: '' description: '' unit_amount: *ref_14 recurring: type: object properties: interval: type: string description: >- The frequency at which a subscription is billed. One of day, week, month or year. enum: *ref_15 x-apifox-enum: - value: day name: '' description: '' - value: week name: '' description: '' - value: month name: '' description: '' - value: year name: '' description: '' interval_count: *ref_16 usage_type: type: string description: Configures how the quantity per period should be determined. enum: *ref_17 x-apifox-enum: - value: licensed name: '' description: '' x-apifox-orders: *ref_18 description: The recurring components of a price required: - interval x-apifox-ignore-properties: [] tiers: type: array items: type: object properties: up_to: *ref_19 flat_amount: *ref_20 unit_amount: *ref_21 x-apifox-orders: *ref_22 x-apifox-ignore-properties: [] description: （未实现） description: The price used to generate the line item. x-apifox-ignore-properties: - id - object - active - billing_scheme - created - currency - livemode - lookup_key - metadata - nickname - product - type - unit_amount - recurring - tiers quantity: type: string description: The quantity of products being purchased. taxes: type: string description: （未实现）The taxes applied to the line item. discounts: type: array items: type: object x-apifox-refs: 01J0Q497B9M5WGP7SNHD8Q4ARN: $ref: '#/components/schemas/Discounts' x-apifox-overrides: invoice: null invoice_item: null x-apifox-orders: - 01J0Q497B9M5WGP7SNHD8Q4ARN properties: id: &ref_39 type: string description: >- The ID of the discount object. Discounts cannot be fetched by ID. object: &ref_40 type: string description: >- String representing the object’s type. Objects of the same type share the same value. checkout_session: &ref_41 type: string description: >- The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. coupon: type: object x-apifox-refs: &ref_42 01HV3JTJ0FGTEWBDHHFJ74FZBE: $ref: '#/components/schemas/Coupons' x-apifox-overrides: duration_in_weeks: null duration_in_months: null duration: null applies_to: null x-apifox-orders: &ref_43 - 01HV3JTJ0FGTEWBDHHFJ74FZBE properties: id: &ref_23 type: string description: Unique identifier for the object. amount_off: &ref_24 type: integer description: >- Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. nullable: true currency: &ref_25 type: string description: >- If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. nullable: true duration_in_days: &ref_26 type: string description: >- Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect. object: &ref_27 type: string description: >- String representing the object’s type. Objects of the same type share the same value. created: &ref_28 type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. livemode: &ref_29 type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata: type: object properties: {} x-apifox-orders: &ref_30 [] description: >- 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. x-apifox-ignore-properties: [] name: &ref_31 type: string description: >- Name of the coupon displayed to customers on for instance invoices or receipts. percent_off: &ref_32 type: number description: >- Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead. nullable: true max_redemptions: &ref_33 type: integer description: >- Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. nullable: true redeem_by: &ref_34 type: integer description: Date after which the coupon can no longer be redeemed. nullable: true times_redeemed: &ref_35 type: integer description: >- Number of times this coupon has been applied to a customer. valid: &ref_36 type: boolean description: >- Taking account of the above properties, whether this coupon can still be applied to a customer. currency_options: type: object properties: .amount_off: &ref_37 type: integer description: >- Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. description: >- Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. x-apifox-orders: &ref_38 - .amount_off x-apifox-ignore-properties: [] description: Hash describing the coupon applied to create this discount. required: - duration_in_days x-apifox-ignore-properties: - id - amount_off - currency - duration_in_days - object - created - livemode - metadata - name - percent_off - max_redemptions - redeem_by - times_redeemed - valid - currency_options customer: &ref_44 type: string description: The ID of the customer associated with this discount. start: &ref_45 type: integer description: Date that the coupon was applied. end: &ref_46 type: 'null' description: >- If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. promotion_code: &ref_47 type: 'null' description: The promotion code applied to create this discount. subscription: &ref_48 type: 'null' description: >- The subscription that this coupon is applied to, if it is applied to a particular subscription. x-apifox-ignore-properties: - id - object - checkout_session - coupon - customer - start - end - promotion_code - subscription description: The discounts applied to the line item. amount_discount: type: integer description: >- Total discount amount applied. If no discounts were applied, defaults to 0. amount_tax: type: string description: （未实现）Total tax amount applied. If no tax was applied, defaults to 0. x-apifox-orders: - id - object - amount_subtotal - amount_total - currency - description - price - quantity - taxes - discounts - amount_discount - amount_tax x-apifox-ignore-properties: [] x-apifox-folder: '' Coupons: type: object properties: id: *ref_23 amount_off: *ref_24 currency: *ref_25 duration: type: string description: >- One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. enum: - forever - once - repeating x-apifox-enum: - value: forever name: '' description: >- Applies to all charges from a subscription with this coupon applied. - value: once name: '' description: >- Applies to the first charge from a subscription with this coupon applied. - value: repeating name: '' description: >- Applies to charges in the first duration_in_months months from a subscription with this coupon applied. duration_in_months: type: integer description: >- Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect. duration_in_weeks: type: string description: >- Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect. duration_in_days: *ref_26 object: *ref_27 created: *ref_28 livemode: *ref_29 metadata: type: object properties: {} x-apifox-orders: *ref_30 description: >- 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. x-apifox-ignore-properties: [] name: *ref_31 percent_off: *ref_32 max_redemptions: *ref_33 redeem_by: *ref_34 times_redeemed: *ref_35 valid: *ref_36 applies_to: type: object properties: products: type: array items: type: string description: A list of product IDs this coupon applies to description: Contains information about what this coupon applies to. x-apifox-orders: - products x-apifox-ignore-properties: [] currency_options: type: object properties: .amount_off: *ref_37 description: >- Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. x-apifox-orders: *ref_38 x-apifox-ignore-properties: [] x-apifox-orders: - id - amount_off - currency - duration - duration_in_months - duration_in_weeks - duration_in_days - object - created - livemode - metadata - name - percent_off - max_redemptions - redeem_by - times_redeemed - valid - applies_to - currency_options required: - duration_in_weeks - duration_in_days x-apifox-ignore-properties: [] x-apifox-folder: '' Discounts: type: object properties: id: *ref_39 object: *ref_40 checkout_session: *ref_41 coupon: type: object x-apifox-refs: *ref_42 x-apifox-orders: *ref_43 properties: id: *ref_23 amount_off: *ref_24 currency: *ref_25 duration_in_days: *ref_26 object: *ref_27 created: *ref_28 livemode: *ref_29 metadata: type: object properties: {} x-apifox-orders: *ref_30 description: >- 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. x-apifox-ignore-properties: [] name: *ref_31 percent_off: *ref_32 max_redemptions: *ref_33 redeem_by: *ref_34 times_redeemed: *ref_35 valid: *ref_36 currency_options: type: object properties: .amount_off: *ref_37 description: >- Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. x-apifox-orders: *ref_38 x-apifox-ignore-properties: [] description: Hash describing the coupon applied to create this discount. required: - duration_in_days x-apifox-ignore-properties: - id - amount_off - currency - duration_in_days - object - created - livemode - metadata - name - percent_off - max_redemptions - redeem_by - times_redeemed - valid - currency_options customer: *ref_44 start: *ref_45 end: *ref_46 promotion_code: *ref_47 invoice: type: 'null' description: （未完成） invoice_item: type: 'null' description: （未完成） subscription: *ref_48 x-apifox-orders: - id - object - checkout_session - coupon - customer - start - end - promotion_code - invoice - invoice_item - subscription x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```