{ "info": { "_postman_id": "0115575e-e0af-4717-b0db-8b1d5f030af1", "name": "Square ApplePay Subscriptions API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "lastUpdatedBy": "35240", "uid": "35240-0115575e-e0af-4717-b0db-8b1d5f030af1" }, "item": [ { "name": "v2", "item": [ { "name": "subscriptions", "item": [ { "name": "bulk-swap-plan", "item": [ { "name": "Square Bulk Swap Plan", "id": "494990d6-c755-4c3f-b29c-9214272760cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"new_plan_variation_id\": \"\",\n \"old_plan_variation_id\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/bulk-swap-plan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", "bulk-swap-plan" ] }, "description": "Schedules a plan variation change for all active subscriptions under a given plan\nvariation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations)." }, "response": [ { "id": "ae5d41b2-296d-447a-bb28-9031ad272715", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"new_plan_variation_id\": \"\",\n \"old_plan_variation_id\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/bulk-swap-plan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", "bulk-swap-plan" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_CURSOR\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"NOT_FOUND\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"affected_subscriptions\": \"\"\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-ae5d41b2-296d-447a-bb28-9031ad272715" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-494990d6-c755-4c3f-b29c-9214272760cf" } ], "id": "df421c55-f998-4b24-93b6-22a39ea9aba7", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-df421c55-f998-4b24-93b6-22a39ea9aba7" }, { "name": "search", "item": [ { "name": "Square Search Subscriptions", "id": "59691201-504d-4f25-91a7-d597144cb75a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"limit\": \"\",\n \"query\": {\n \"filter\": {\n \"customer_ids\": [\n \"\",\n \"\"\n ],\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"source_names\": [\n \"\",\n \"\"\n ]\n }\n },\n \"include\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", "search" ] }, "description": "Searches for subscriptions.\n\nResults are ordered chronologically by subscription creation date. If\nthe request specifies more than one location ID,\nthe endpoint orders the result\nby location ID, and then by creation date within each location. If no locations are given\nin the query, all locations are searched.\n\nYou can also optionally specify `customer_ids` to search by customer.\nIf left unset, all customers\nassociated with the specified locations are returned.\nIf the request specifies customer IDs, the endpoint orders results\nfirst by location, within location by customer ID, and within\ncustomer by subscription creation date." }, "response": [ { "id": "3acc7be1-e766-4598-b29c-1d137cafe3ff", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"limit\": \"\",\n \"query\": {\n \"filter\": {\n \"customer_ids\": [\n \"\",\n \"\"\n ],\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"source_names\": [\n \"\",\n \"\"\n ]\n }\n },\n \"include\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_ENUM_VALUE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"XDR\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"RESUME\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-3acc7be1-e766-4598-b29c-1d137cafe3ff" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-59691201-504d-4f25-91a7-d597144cb75a" } ], "id": "f2f6bec8-9608-4b18-9edf-913471b6c70f", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-f2f6bec8-9608-4b18-9edf-913471b6c70f" }, { "name": "{subscription_id}", "item": [ { "name": "actions", "item": [ { "name": "{action_id}", "item": [ { "name": "Square Delete Subscription Action", "id": "b4a23f5a-3b49-405a-b445-f0ac2a79d181", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/actions/:action_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "actions", ":action_id" ], "variable": [ { "id": "ea53d559-ece5-4a15-ac51-ede6727caaff", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription the targeted action is to act upon." }, { "id": "55ca1c31-39f6-49f8-8d64-e2b63814e46b", "key": "action_id", "value": "", "description": "(Required) The ID of the targeted action to be deleted." } ] }, "description": "Deletes a scheduled action for a subscription." }, "response": [ { "id": "951a6e71-1561-47c7-96f1-105bf3eb6463", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/actions/:action_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "actions", ":action_id" ], "variable": [ { "key": "subscription_id" }, { "key": "action_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"INVALID_VALUE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"VALUE_TOO_SHORT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"DEACTIVATED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"YER\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"RESUME\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-951a6e71-1561-47c7-96f1-105bf3eb6463" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-b4a23f5a-3b49-405a-b445-f0ac2a79d181" } ], "id": "8eb0524b-831b-4d64-ba66-280234a61373", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-8eb0524b-831b-4d64-ba66-280234a61373" } ], "id": "6e6d447d-c6f6-4db9-bda0-3a789da52545", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-6e6d447d-c6f6-4db9-bda0-3a789da52545" }, { "name": "billing-anchor", "item": [ { "name": "Square Change Billing Anchor Date", "id": "19f68517-fc98-419f-ac7c-bbdd0b3be9fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"monthly_billing_anchor_date\": \"\",\n \"effective_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/billing-anchor", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "billing-anchor" ], "variable": [ { "id": "cd90abbc-02b8-480a-a6f8-85d69bdcbcdd", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to update the billing anchor date." } ] }, "description": "Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates)\nfor a subscription." }, "response": [ { "id": "819094de-cef4-4784-9f9e-93d2e9d16535", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"monthly_billing_anchor_date\": \"\",\n \"effective_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/billing-anchor", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "billing-anchor" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"INVALID_LOCATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"DEACTIVATED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"GHS\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CANCEL\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-819094de-cef4-4784-9f9e-93d2e9d16535" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-19f68517-fc98-419f-ac7c-bbdd0b3be9fc" } ], "id": "3593a069-19bc-4427-b761-f95f8c806eb5", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-3593a069-19bc-4427-b761-f95f8c806eb5" }, { "name": "cancel", "item": [ { "name": "Square Cancel Subscription", "id": "a5673687-0334-4e84-8723-f4adec48a882", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "cancel" ], "variable": [ { "id": "3699c156-d7f5-4976-937d-f781ea77dc75", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to cancel." } ] }, "description": "Schedules a `CANCEL` action to cancel an active subscription. This \nsets the `canceled_date` field to the end of the active billing period. After this date, \nthe subscription status changes from ACTIVE to CANCELED." }, "response": [ { "id": "f23e43ec-09e0-4031-9215-30bb2d88402e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "cancel" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"EXPECTED_STRING\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PAUSED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"GMD\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CANCEL\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-f23e43ec-09e0-4031-9215-30bb2d88402e" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-a5673687-0334-4e84-8723-f4adec48a882" } ], "id": "ec1da2c8-dc4c-4c80-a259-e10429692119", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-ec1da2c8-dc4c-4c80-a259-e10429692119" }, { "name": "events", "item": [ { "name": "Square List Subscription Events", "id": "8076d3f3-8890-4d9f-8889-d3b58416e5db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/events?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "events" ], "query": [ { "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The upper limit on the number of subscription events to return\nin a paged response.", "key": "limit", "value": "" } ], "variable": [ { "id": "9156d4f1-52fb-4d25-861a-b863c17deccb", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to retrieve the events for." } ] }, "description": "Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription." }, "response": [ { "id": "e74ce7a9-93ec-4f1a-8e90-b7cd63fb7aec", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/events?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "events" ], "query": [ { "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The upper limit on the number of subscription events to return\nin a paged response.", "key": "limit", "value": "" } ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"REFUND_ALREADY_PENDING\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"DELAYED_TRANSACTION_CANCELED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription_events\": [\n {\n \"id\": \"\",\n \"subscription_event_type\": \"START_SUBSCRIPTION\",\n \"effective_date\": \"\",\n \"plan_variation_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"info\": {\n \"detail\": \"\",\n \"code\": \"LOCATION_CANNOT_ACCEPT_PAYMENT\"\n },\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"subscription_event_type\": \"DEACTIVATE_SUBSCRIPTION\",\n \"effective_date\": \"\",\n \"plan_variation_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"info\": {\n \"detail\": \"\",\n \"code\": \"LOCATION_CANNOT_ACCEPT_PAYMENT\"\n },\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-e74ce7a9-93ec-4f1a-8e90-b7cd63fb7aec" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-8076d3f3-8890-4d9f-8889-d3b58416e5db" } ], "id": "8660dd17-7b91-4d6a-9af7-303d6ca1334d", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-8660dd17-7b91-4d6a-9af7-303d6ca1334d" }, { "name": "pause", "item": [ { "name": "Square Pause Subscription", "id": "1e4c30eb-82c9-4616-98b8-21dead15d7a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pause_effective_date\": \"\",\n \"pause_cycle_duration\": \"\",\n \"resume_effective_date\": \"\",\n \"resume_change_timing\": \"IMMEDIATE\",\n \"pause_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "pause" ], "variable": [ { "id": "8eff7ee0-4fb1-4eb6-a535-0782b35f4870", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to pause." } ] }, "description": "Schedules a `PAUSE` action to pause an active subscription." }, "response": [ { "id": "d61476df-84cf-49d9-92d3-b314323a35fd", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"pause_effective_date\": \"\",\n \"pause_cycle_duration\": \"\",\n \"resume_effective_date\": \"\",\n \"resume_change_timing\": \"IMMEDIATE\",\n \"pause_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "pause" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"REQUEST_TIMEOUT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"ANG\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CANCEL\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-d61476df-84cf-49d9-92d3-b314323a35fd" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-1e4c30eb-82c9-4616-98b8-21dead15d7a9" } ], "id": "3b9bf1fe-4d69-468b-a6d0-9c7596be91e0", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-3b9bf1fe-4d69-468b-a6d0-9c7596be91e0" }, { "name": "resume", "item": [ { "name": "Square Resume Subscription", "id": "ea0b8db4-01e9-4c15-b563-f5e5b2514d86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"resume_effective_date\": \"\",\n \"resume_change_timing\": \"END_OF_BILLING_CYCLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "resume" ], "variable": [ { "id": "e4d8951a-2b19-47e7-a556-70d9402de6f3", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to resume." } ] }, "description": "Schedules a `RESUME` action to resume a paused or a deactivated subscription." }, "response": [ { "id": "c4cdc69b-8edf-4c4c-8cff-b011a824fc17", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"resume_effective_date\": \"\",\n \"resume_change_timing\": \"END_OF_BILLING_CYCLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "resume" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"ARRAY_EMPTY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"SWAP_PLAN\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"SWAP_PLAN\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-c4cdc69b-8edf-4c4c-8cff-b011a824fc17" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-ea0b8db4-01e9-4c15-b563-f5e5b2514d86" } ], "id": "6cda2bed-b938-4063-bd4b-5d3c42114187", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-6cda2bed-b938-4063-bd4b-5d3c42114187" }, { "name": "swap-plan", "item": [ { "name": "Square Swap Plan", "id": "aaa88311-87b1-4db9-8aab-d148f0402769", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"new_plan_variation_id\": \"\",\n \"phases\": [\n {\n \"ordinal\": \"\",\n \"order_template_id\": \"\"\n },\n {\n \"ordinal\": \"\",\n \"order_template_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/swap-plan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "swap-plan" ], "variable": [ { "id": "a344adda-c0d8-45bd-a196-295ad2214325", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to swap the subscription plan for." } ] }, "description": "Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. \nFor more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations)." }, "response": [ { "id": "f9c67ee5-29b5-461e-b76c-6e47ec4e1763", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"new_plan_variation_id\": \"\",\n \"phases\": [\n {\n \"ordinal\": \"\",\n \"order_template_id\": \"\"\n },\n {\n \"ordinal\": \"\",\n \"order_template_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id/swap-plan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id", "swap-plan" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"BAD_REQUEST\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"DEACTIVATED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"ERN\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"SWAP_PLAN\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"PAUSE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-f9c67ee5-29b5-461e-b76c-6e47ec4e1763" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-aaa88311-87b1-4db9-8aab-d148f0402769" } ], "id": "100b3cf9-ae9b-44a4-a74a-168c2f10a111", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-100b3cf9-ae9b-44a4-a74a-168c2f10a111" }, { "name": "Square Retrieve Subscription", "id": "0024e30d-d631-4b41-8998-a4991b6b1b9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id" ], "query": [ { "description": "A query parameter to specify related information to be included in the response. \n\nThe supported query parameter values are: \n\n- `actions`: to include scheduled actions on the targeted subscription.", "key": "include", "value": "" } ], "variable": [ { "id": "fb21f401-5804-4612-885d-61f9ca19ede1", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to retrieve." } ] }, "description": "Retrieves a specific subscription." }, "response": [ { "id": "b6126b73-5d8a-4bc1-b34f-9c9a9f632e9b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id" ], "query": [ { "description": "A query parameter to specify related information to be included in the response. \n\nThe supported query parameter values are: \n\n- `actions`: to include scheduled actions on the targeted subscription.", "key": "include", "value": "" } ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"GONE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"ACCOUNT_UNUSABLE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PAUSED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"JPY\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"SWAP_PLAN\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"RESUME\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-b6126b73-5d8a-4bc1-b34f-9c9a9f632e9b" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-0024e30d-d631-4b41-8998-a4991b6b1b9d" }, { "name": "Square Update Subscription", "id": "40cbdee5-bed3-4232-9471-e45b44c62c24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PAUSED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"SEK\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CANCEL\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"PAUSE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id" ], "variable": [ { "id": "8878c161-6de0-4c47-9b4b-d58f887ad4c0", "key": "subscription_id", "value": "", "description": "(Required) The ID of the subscription to update." } ] }, "description": "Updates a subscription by modifying or clearing `subscription` field values.\nTo clear a field, set its value to `null`." }, "response": [ { "id": "a42f07c8-ecf9-4fe9-8d22-93a20a5cec28", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PAUSED\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"SEK\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CANCEL\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"PAUSE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions", ":subscription_id" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"REQUEST_ENTITY_TOO_LARGE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"INVALID_FEES\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"BIF\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"RESUME\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-a42f07c8-ecf9-4fe9-8d22-93a20a5cec28" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-40cbdee5-bed3-4232-9471-e45b44c62c24" } ], "id": "a4df1648-ef4f-4c1c-ac36-075e207283fe", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-a4df1648-ef4f-4c1c-ac36-075e207283fe" }, { "name": "Square Create Subscription", "id": "264c4d5d-e2ac-40ce-b640-5d5ba4341381", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"location_id\": \"\",\n \"customer_id\": \"\",\n \"idempotency_key\": \"\",\n \"plan_variation_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"tax_percentage\": \"\",\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n },\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions" ] }, "description": "Enrolls a customer in a subscription.\n\nIf you provide a card on file in the request, Square charges the card for\nthe subscription. Otherwise, Square sends an invoice to the customer's email\naddress. The subscription starts immediately, unless the request includes\nthe optional `start_date`. Each individual subscription is associated with a particular location.\n\nFor more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription)." }, "response": [ { "id": "95409a6d-a8b4-4c11-9a87-68f09addeced", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"location_id\": \"\",\n \"customer_id\": \"\",\n \"idempotency_key\": \"\",\n \"plan_variation_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"tax_percentage\": \"\",\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n },\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"MAP_KEY_LENGTH_TOO_LONG\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"INVALID_CARD_DATA\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"location_id\": \"\",\n \"plan_variation_id\": \"\",\n \"customer_id\": \"\",\n \"start_date\": \"\",\n \"canceled_date\": \"\",\n \"charged_through_date\": \"\",\n \"status\": \"ACTIVE\",\n \"tax_percentage\": \"\",\n \"invoice_ids\": [\n \"\",\n \"\"\n ],\n \"price_override_money\": {\n \"amount\": \"\",\n \"currency\": \"XBB\"\n },\n \"version\": \"\",\n \"created_at\": \"\",\n \"card_id\": \"\",\n \"timezone\": \"\",\n \"source\": {\n \"name\": \"\"\n },\n \"actions\": [\n {\n \"id\": \"\",\n \"type\": \"RESUME\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"CHANGE_BILLING_ANCHOR_DATE\",\n \"effective_date\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ],\n \"new_plan_variation_id\": \"\"\n }\n ],\n \"monthly_billing_anchor_date\": \"\",\n \"phases\": [\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n },\n {\n \"uid\": \"\",\n \"ordinal\": \"\",\n \"order_template_id\": \"\",\n \"plan_phase_uid\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-95409a6d-a8b4-4c11-9a87-68f09addeced" } ], "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-264c4d5d-e2ac-40ce-b640-5d5ba4341381" } ], "id": "f5dc9b79-0d24-4917-bf9f-7afc7d7423d3", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-f5dc9b79-0d24-4917-bf9f-7afc7d7423d3" } ], "id": "daf34bc3-03a2-4c28-8a78-db2dbf0c941c", "createdAt": "2026-07-28T03:04:38.000Z", "updatedAt": "2026-07-28T03:04:38.000Z", "uid": "35240-daf34bc3-03a2-4c28-8a78-db2dbf0c941c" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }