openapi: 3.2.0 info: title: Online Store Subscriptions API version: '1.0' description: Online Store API servers: - url: https://www.yoursite.com/api/v1 description: '' security: - X-AC-Auth-Token: [] tags: - name: Subscriptions paths: /subscriptions: get: summary: Get Subscriptions tags: - Subscriptions responses: '200': description: OK content: application/json: schema: type: object properties: total_count: type: integer subscriptions: type: array items: $ref: '#/components/schemas/subscriptions' operationId: get-subscriptions description: Gets an aray of subscriptions. post: summary: Create a Subscription operationId: post-subscriptions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/subscriptions' description: Creates a subscription. tags: - Subscriptions requestBody: content: application/json: schema: description: '' type: object x-examples: example-1: saved_cart_id: 139 customer_id: 18 next_due_at: '2022-08-01T00:00:00-05:00' frequency_type: Months frequency: 1 drip_series_id: 0 original_order_id: 100039 shipping_method_name: USPS;USPS Media Mail;USPS Media Mail customer_payment_method_id: 27 shipping_address_id: 170 billing_address_id: 169 is_enabled: false latest_renewal_order_id: null is_renewal_payment_declined: false renewal_count: 0 one_time_customer_notice: '' customer_notice: '' properties: saved_cart_id: type: integer customer_id: type: integer next_due_at: type: string frequency_type: type: string frequency: type: number drip_series_id: type: integer original_order_id: type: integer shipping_method_name: type: string customer_payment_method_id: type: integer shipping_address_id: type: integer billing_address_id: type: integer is_enabled: type: boolean latest_renewal_order_id: type: integer is_renewal_payment_declined: type: boolean renewal_count: type: number one_time_customer_notice: type: string customer_notice: type: string required: - customer_id - frequency_type - frequency - original_order_id - shipping_method_name - customer_payment_method_id - shipping_address_id - billing_address_id examples: Example: value: saved_cart_id: 139 customer_id: 18 next_due_at: '2022-08-01T00:00:00-05:00' frequency_type: Months frequency: 1 drip_series_id: 0 original_order_id: 100039 shipping_method_name: USPS;USPS Media Mail;USPS Media Mail customer_payment_method_id: 27 shipping_address_id: 170 billing_address_id: 169 is_enabled: false latest_renewal_order_id: 245 is_renewal_payment_declined: false renewal_count: 0 one_time_customer_notice: '' customer_notice: '' /subscriptions/{id}: parameters: - schema: type: string name: id in: path required: true description: The ID of the `subscription` put: summary: Update a Subscription operationId: put-subscriptions-id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/subscriptions' tags: - Subscriptions description: Updates a subscription. requestBody: content: application/json: schema: $ref: '#/components/schemas/subscriptions' delete: summary: Delete a Subscription operationId: delete-subscriptions-id responses: '200': description: OK '404': $ref: '#/components/responses/404' description: Deletes a subscription tags: - Subscriptions components: schemas: subscriptions: type: object x-examples: example-1: id: 5 saved_cart_id: 128 customer_id: 1 next_due_at: '2022-04-07T20:38:27.58+05:00' frequency_type: Months frequency: 3 drip_series_id: 1 original_order_id: 100008 shipping_method_name: Priority Shipping updated_at: '2022-01-07T20:38:27.59+05:00' created_at: '2022-01-07T20:38:27.59+05:00' customer_payment_method_id: 98 shipping_address_id: 267 billing_address_id: 267 is_enabled: true latest_renewal_order_id: null is_renewal_payment_declined: false renewal_count: 0 one_time_customer_notice: '' customer_notice: '' cart_info: id: 128 name: 'Sub for: 100008 - 100008' cart_type: SavedCart customer_id: 6 is_public: false updated_at: '2022-01-07T20:38:27.573+05:00' created_at: '2022-01-07T20:38:27.573+05:00' store_id: 1 session_id: 343 discount_total: 0 subtotal: 5500 shipping_total: 0 handling_total: 0 tax_total: 0 grand_total: 5500 tax_rate: 0 additional_fees: 0 discounted_shipping_total: 0 region_markup_amount: null non_shipping_discount: 0 gift_certificate_discount: null coupon_code: '' associated_order_id: null shipping_estimate_city: '' shipping_estimate_state_code: '' shipping_estimate_postal_code: '' shipping_estimate_country_code: '' is_shipping_billed_to_account: false customer_payment_method_id: null payment_method_id: null is_payment_cart_only: false items: - id: 439 product_id: 62 item_number: '' quantity: 1 price: 5500 cost: 0 shipping_address_id: 39 item_thumbnail: /images/LG/_thumb_60_50PY2DR_bic.jpg item_url: '' item_name: 60PY2DR warehouse_id: 0 parent_product_id: null parent_cart_item_id: null updated_at: '2022-01-07T20:38:27.573+05:00' created_at: '2022-01-07T20:38:27.573+05:00' cart_id: 128 is_subscription_product: true vendor_store_id: null fitment: '' configuration: '' variants: null personalizations: null subscription_paused: false customer: id: 1 customer_number: '' last_name: lastname first_name: firstname email: test@test.com phone_number: '' registered_at: '2004-10-08T00:00:00+05:00' last_visit_at: '2005-09-08T13:48:55+05:00' adcode: '' adcode_id: 0 affiliate_id: 0 customer_type_id: 1 is_no_tax_customer: false comments: '' store_id: 1 source: '' search_string: '' no_account: false sales_person: '' alternate_phone_number: '' is_affiliate_customer: false updated_at: '2022-03-04T18:21:45.413+05:00' created_at: null username: '' is_contact_information_only: false tax_exemption_number: '' company: '' source_group: '' sales_person_user_id: null store_payment_methods_enabled: [] tax_rate: null reward_tier_id: null sub: '' shipping_address: id: 267 customer_id: 1 company: Cart address_line_1: mckldmcdm address_line_2: '' city: New York state: New York country: United States postal_code: '10001' phone: '111111111111111111111111111111' alternate_phone: '' fax: '' comments: '' updated_at: '2022-01-07T20:38:27.463+05:00' created_at: '2022-01-07T20:38:27.463+05:00' first_name: Salman last_name: L address_type: Default customer_payment_method: id: 98 payment_method_id: 193 customer_id: 8 payment_type: CreditCard is_default: true card_id: 33 updated_at: '2022-03-07T21:57:16.773+05:00' created_at: '2022-03-07T21:57:16.773+05:00' address_id: null examples: - id: 5 saved_cart_id: 128 customer_id: 1 next_due_at: '2022-04-07T20:38:27.58+05:00' frequency_type: Months frequency: 3 drip_series_id: 1 original_order_id: 100008 shipping_method_name: Priority Shipping updated_at: '2022-01-07T20:38:27.59+05:00' created_at: '2022-01-07T20:38:27.59+05:00' customer_payment_method_id: 98 shipping_address_id: 267 billing_address_id: 267 is_enabled: true latest_renewal_order_id: null is_renewal_payment_declined: false renewal_count: 0 one_time_customer_notice: '' customer_notice: '' cart_info: id: 128 name: 'Sub for: 100008 - 100008' cart_type: SavedCart customer_id: 6 is_public: false updated_at: '2022-01-07T20:38:27.573+05:00' created_at: '2022-01-07T20:38:27.573+05:00' store_id: 1 session_id: 343 discount_total: 0 subtotal: 5500 shipping_total: 0 handling_total: 0 tax_total: 0 grand_total: 5500 tax_rate: 0 additional_fees: 0 discounted_shipping_total: 0 region_markup_amount: null non_shipping_discount: 0 gift_certificate_discount: null coupon_code: '' associated_order_id: null shipping_estimate_city: '' shipping_estimate_state_code: '' shipping_estimate_postal_code: '' shipping_estimate_country_code: '' is_shipping_billed_to_account: false customer_payment_method_id: null payment_method_id: null is_payment_cart_only: false items: - id: 439 product_id: 62 item_number: '' quantity: 1 price: 5500 cost: 0 shipping_address_id: 39 item_thumbnail: /images/LG/_thumb_60_50PY2DR_bic.jpg item_url: '' item_name: 60PY2DR warehouse_id: 0 parent_product_id: null parent_cart_item_id: null updated_at: '2022-01-07T20:38:27.573+05:00' created_at: '2022-01-07T20:38:27.573+05:00' cart_id: 128 is_subscription_product: true vendor_store_id: null fitment: '' configuration: '' variants: null personalizations: null subscription_paused: false customer: id: 1 customer_number: '' last_name: LastName first_name: FirstName email: test@test.com phone_number: '' registered_at: '2004-10-08T00:00:00+05:00' last_visit_at: '2005-09-08T13:48:55+05:00' adcode: '' adcode_id: 0 affiliate_id: 0 customer_type_id: 1 is_no_tax_customer: false comments: '' store_id: 1 source: '' search_string: '' no_account: false sales_person: '' alternate_phone_number: '' is_affiliate_customer: false updated_at: '2022-03-04T18:21:45.413+05:00' created_at: null username: '' is_contact_information_only: false tax_exemption_number: '' company: '' source_group: '' sales_person_user_id: null store_payment_methods_enabled: [] tax_rate: null lock_default_address: false reward_tier_id: null payment_net_term: 0 credit_limit: 0.0 is_inactive: false use_shared_credit_limit: false override_shared_credit_limit: false default_payment_type_name: Credit Card shipping_address: id: 267 customer_id: 1 company: Cart address_line_1: 123Test address_line_2: '' city: New York state: New York country: United States postal_code: '10001' phone: '111111111111111111111111111111' alternate_phone: '' fax: '' comments: '' updated_at: '2022-01-07T20:38:27.463+05:00' created_at: '2022-01-07T20:38:27.463+05:00' first_name: FirstName last_name: LastName address_type: Default state_code: NY country_code: US customer_payment_method: id: 98 payment_method_id: 193 customer_id: 8 payment_type: CreditCard is_default: true card_id: 33 updated_at: '2022-03-07T21:57:16.773+05:00' created_at: '2022-03-07T21:57:16.773+05:00' address_id: null description: If you want child resources included in response you must pass the query parameter 'includeLookups = true' title: Subscriptions properties: id: type: integer saved_cart_id: type: integer customer_id: type: integer next_due_at: type: string frequency_type: type: string frequency: type: integer drip_series_id: type: integer original_order_id: type: integer shipping_method_name: type: string updated_at: type: string created_at: type: string customer_payment_method_id: type: integer shipping_address_id: type: integer billing_address_id: type: integer is_enabled: type: boolean latest_renewal_order_id: type: integer is_renewal_payment_declined: type: boolean renewal_count: type: integer one_time_customer_notice: type: string customer_notice: type: string cart_info: type: object properties: id: type: integer name: type: string cart_type: type: string customer_id: type: integer is_public: type: boolean updated_at: type: string created_at: type: string store_id: type: integer session_id: type: integer discount_total: type: integer subtotal: type: integer shipping_total: type: integer handling_total: type: integer tax_total: type: integer grand_total: type: integer tax_rate: type: integer additional_fees: type: integer discounted_shipping_total: type: integer region_markup_amount: type: integer non_shipping_discount: type: integer gift_certificate_discount: type: integer coupon_code: type: string associated_order_id: type: integer shipping_estimate_city: type: string shipping_estimate_state_code: type: string shipping_estimate_postal_code: type: string shipping_estimate_country_code: type: string is_shipping_billed_to_account: type: boolean customer_payment_method_id: type: integer payment_method_id: {} is_payment_cart_only: type: boolean items: type: array items: type: object properties: id: type: integer product_id: type: integer item_number: type: string quantity: type: integer price: type: integer cost: type: integer shipping_address_id: type: integer item_thumbnail: type: string item_url: type: string item_name: type: string warehouse_id: type: integer parent_product_id: type: integer parent_cart_item_id: type: integer updated_at: type: string created_at: type: string cart_id: type: integer is_subscription_product: type: boolean configuration: type: string variants: type: object personalizations: type: object subscription_paused: type: boolean customer: type: object properties: id: type: integer customer_number: type: string last_name: type: string first_name: type: string email: type: string phone_number: type: string registered_at: type: string last_visit_at: type: string adcode: type: string adcode_id: type: integer customer_type_id: type: integer is_no_tax_customer: type: boolean comments: type: string store_id: type: integer source: type: string search_string: type: string no_account: type: boolean sales_person: type: string alternate_phone_number: type: string is_affiliate_customer: type: boolean updated_at: type: string created_at: type: string username: type: string is_contact_information_only: type: boolean tax_exemption_number: type: string company: type: string source_group: type: string sales_person_user_id: type: integer store_payment_methods_enabled: type: array items: type: string tax_rate: type: integer lock_default_address: type: boolean reward_tier_id: type: integer payment_net_term: type: integer credit_limit: type: number is_inactive: type: boolean use_shared_credit_limit: type: boolean override_shared_credit_limit: type: boolean default_payment_type_name: type: string shipping_address: type: object properties: id: type: integer customer_id: type: integer company: type: string address_line_1: type: string address_line_2: type: string city: type: string state: type: string country: type: string postal_code: type: string phone: type: string alternate_phone: type: string fax: type: string comments: type: string updated_at: type: string created_at: type: string first_name: type: string last_name: type: string address_type: type: string state_code: type: string country_code: type: string customer_payment_method: type: object properties: id: type: integer payment_method_id: type: integer customer_id: type: integer payment_type: type: string is_default: type: boolean card_id: type: integer updated_at: type: string created_at: type: string address_id: type: integer responses: '404': description: Resource Not Found content: application/json: schema: description: Not Found type: object x-examples: example-1: status_code: 404 message: Not Found details: No resource found properties: status_code: type: number message: type: string details: type: string examples: {} headers: {} securitySchemes: X-AC-Auth-Token: name: X-AC-Auth-Token type: apiKey in: header