{ "openapi" : "3.0.0", "info" : { "title" : "Collections", "description" : "Manage Payment Collection Settings", "version" : "0.1" }, "servers" : [ { "url" : "https://dev.seqhq.io/api", "description" : "DEV" }, { "url" : "https://sandbox.sequencehq.com/api", "description" : "SANDBOX" }, { "url" : "https://eu.sequencehq.com/api", "description" : "PRODUCTION" } ], "tags" : [ { "name" : "Invoices" }, { "name" : "Customers" }, { "name" : "Account Settings" }, { "name" : "Billing Schedules" }, { "name" : "Stripe Collection Settings" } ], "paths" : { "/payments/settings/invoices/{id}" : { "get" : { "tags" : [ "Invoices" ], "summary" : "Get invoice payment settings", "description" : "Get payment settings for invoices. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.", "operationId" : "getPaymentsSettingsInvoicesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductGetInvoiceSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductGetInvoiceSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Invoices" ], "summary" : "Update invoice payment settings", "description" : "Update payment settings for invoices. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.", "operationId" : "putPaymentsSettingsInvoicesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateInvoiceSettingsRequestModel", "example" : { "paymentProvider" : "STRIPE" } }, "examples" : { "UpdateInvoiceSettingsRequestModel" : { "summary" : "", "value" : { "paymentProvider" : "STRIPE" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductUpdateInvoiceSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductUpdateInvoiceSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "delete" : { "tags" : [ "Invoices" ], "summary" : "Delete invoice payment settings", "description" : "Delete payment settings for invoices. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.", "operationId" : "deletePaymentsSettingsInvoicesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductDeleteInvoiceSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductDeleteInvoiceSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/customers/{id}" : { "get" : { "tags" : [ "Customers" ], "summary" : "Get customer payment settings", "description" : "Get payment settings for customers. Invoices for customers with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. You can override customer payment settings with billing schedule payment settings and invoice payment settings.", "operationId" : "getPaymentsSettingsCustomersById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductGetCustomerSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductGetCustomerSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Customers" ], "summary" : "Update customer payment settings", "description" : "Update payment settings for customers. Invoices for customers with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. You can override customer payment settings with billing schedule payment settings and invoice payment settings.", "operationId" : "putPaymentsSettingsCustomersById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateCustomerSettingsRequestModel", "example" : { "paymentProvider" : "STRIPE" } }, "examples" : { "UpdateCustomerSettingsRequestModel" : { "summary" : "", "value" : { "paymentProvider" : "STRIPE" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductUpdateCustomerSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductUpdateCustomerSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "delete" : { "tags" : [ "Customers" ], "summary" : "Delete customer payment settings", "description" : "Delete payment settings for customers. Invoices for customers with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. You can override customer payment settings with billing schedule payment settings and invoice payment settings.", "operationId" : "deletePaymentsSettingsCustomersById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductDeleteCustomerSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductDeleteCustomerSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/invoices" : { "post" : { "tags" : [ "Invoices" ], "summary" : "Create invoice payment settings", "description" : "Create payment settings for invoices. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.", "operationId" : "postPaymentsSettingsInvoices", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateInvoiceSettingsRequestModel", "example" : { "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "CreateInvoiceSettingsRequestModel" : { "summary" : "", "value" : { "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductCreateInvoiceSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductCreateInvoiceSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings" : { "get" : { "tags" : [ "Account Settings" ], "summary" : "Payment settings for Sequence account", "description" : "Retrieves payment settings for the current Sequence accounts. If no settings exist, default settings will be returned.", "operationId" : "getPaymentsSettings", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountPaymentSettings", "example" : { "id" : "e095e00f-36af-44c9-8c53-3e25677ce8ce", "failureNotifications" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" } } }, "examples" : { "AccountPaymentSettings" : { "summary" : "", "value" : { "id" : "e095e00f-36af-44c9-8c53-3e25677ce8ce", "failureNotifications" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" } } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/billing-schedules/{id}" : { "get" : { "tags" : [ "Billing Schedules" ], "summary" : "Get billing schedule payment settings", "description" : "Get payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.", "operationId" : "getPaymentsSettingsBillingSchedulesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BillingScheduleSettings", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "BillingScheduleSettings" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } } } } }, "put" : { "tags" : [ "Billing Schedules" ], "summary" : "Update billing schedule payment settings", "description" : "Update payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.", "operationId" : "putPaymentsSettingsBillingSchedulesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateBillingScheduleSettingsRequestModel", "example" : { "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "UpdateBillingScheduleSettingsRequestModel" : { "summary" : "", "value" : { "paymentProvider" : "STRIPE", "autoCharge" : true } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BillingScheduleSettings", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "BillingScheduleSettings" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } } } } }, "delete" : { "tags" : [ "Billing Schedules" ], "summary" : "Delete billing schedule payment settings", "description" : "Delete payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.", "operationId" : "deletePaymentsSettingsBillingSchedulesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BillingScheduleSettings", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "BillingScheduleSettings" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/customers" : { "post" : { "tags" : [ "Customers" ], "summary" : "Create customer payment settings", "description" : "Create payment settings for customers. Invoices for customers with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. You can override customer payment settings with billing schedule payment settings and invoice payment settings.", "operationId" : "postPaymentsSettingsCustomers", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCustomerSettingsRequestModel", "example" : { "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "CreateCustomerSettingsRequestModel" : { "summary" : "", "value" : { "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductCreateCustomerSettingsResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductCreateCustomerSettingsResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/stripe/collections/settings/{id}" : { "put" : { "tags" : [ "Stripe Collection Settings" ], "summary" : "Update Stripe collection settings for Sequence account", "description" : "Updates Stripe collection settings for the current Sequence accounts.", "operationId" : "putStripeCollectionsSettingsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Stripe Collection Settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateStripeCollectionSettingsRequest", "example" : { "enableAutomaticPayments" : false, "autoEnableStripePayments" : true, "retryAnchor" : "DUE_DATE", "retryOffsetDays" : [ 0, 7, 14 ] } }, "examples" : { "UpdateStripeCollectionSettingsRequest" : { "summary" : "", "value" : { "enableAutomaticPayments" : false, "autoEnableStripePayments" : true, "retryAnchor" : "DUE_DATE", "retryOffsetDays" : [ 0, 7, 14 ] } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StripeCollectionSettings", "example" : { "id" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c", "sequenceAccountId" : "683fe518-60c8-429f-9320-8aa7efc20bcc", "enableAutomaticPayments" : true, "autoEnableStripePayments" : false, "retryOffsetDays" : [ ] } }, "examples" : { "StripeCollectionSettings" : { "summary" : "", "value" : { "id" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c", "sequenceAccountId" : "683fe518-60c8-429f-9320-8aa7efc20bcc", "enableAutomaticPayments" : true, "autoEnableStripePayments" : false, "retryOffsetDays" : [ ] } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/{id}" : { "put" : { "tags" : [ "Account Settings" ], "summary" : "Update payment settings for Sequence account", "description" : "Updates payment settings for the current Sequence accounts.", "operationId" : "putPaymentsSettingsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Account Payment Settings ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateAccountPaymentSettingsRequest", "example" : { "failureNotifications" : { "merchantNotifications" : "DO_NOT_SEND_NOTIFICATIONS", "customerNotifications" : "DO_NOT_SEND_NOTIFICATIONS" } } }, "examples" : { "UpdateAccountPaymentSettingsRequest" : { "summary" : "", "value" : { "failureNotifications" : { "merchantNotifications" : "DO_NOT_SEND_NOTIFICATIONS", "customerNotifications" : "DO_NOT_SEND_NOTIFICATIONS" } } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountPaymentSettings", "example" : { "id" : "e095e00f-36af-44c9-8c53-3e25677ce8ce", "failureNotifications" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" } } }, "examples" : { "AccountPaymentSettings" : { "summary" : "", "value" : { "id" : "e095e00f-36af-44c9-8c53-3e25677ce8ce", "failureNotifications" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" } } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/invoices/for-invoice/{id}" : { "get" : { "tags" : [ "Invoices" ], "summary" : "Get invoice payment settings by invoice ID", "description" : "Get payment settings for invoices by invoice ID. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.", "operationId" : "getPaymentsSettingsInvoicesForInvoiceById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique invoice ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductGetInvoiceSettingsForInvoiceResponseModel", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } }, "examples" : { "ProductGetInvoiceSettingsForInvoiceResponseModel" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/billing-schedules" : { "post" : { "tags" : [ "Billing Schedules" ], "summary" : "Create billing schedule payment settings", "description" : "Create payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.", "operationId" : "postPaymentsSettingsBillingSchedules", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateBillingScheduleSettingsRequestModel", "example" : { "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "CreateBillingScheduleSettingsRequestModel" : { "summary" : "", "value" : { "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BillingScheduleSettings", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "BillingScheduleSettings" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/stripe/collections/settings" : { "get" : { "tags" : [ "Stripe Collection Settings" ], "summary" : "Stripe collection settings for Sequence account", "description" : "Retrieves Stripe collection settings for the current Sequence accounts. If no settings exist, default settings will be returned.", "operationId" : "getStripeCollectionsSettings", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StripeCollectionSettings", "example" : { "id" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c", "sequenceAccountId" : "683fe518-60c8-429f-9320-8aa7efc20bcc", "enableAutomaticPayments" : true, "autoEnableStripePayments" : false, "retryOffsetDays" : [ ] } }, "examples" : { "StripeCollectionSettings" : { "summary" : "", "value" : { "id" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c", "sequenceAccountId" : "683fe518-60c8-429f-9320-8aa7efc20bcc", "enableAutomaticPayments" : true, "autoEnableStripePayments" : false, "retryOffsetDays" : [ ] } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/payments/settings/billing-schedules/for-billing-schedule/{id}" : { "get" : { "tags" : [ "Billing Schedules" ], "summary" : "Get billing schedule payment settings by billing schedule ID", "description" : "Get payment settings for billing schedules by billing schedule ID. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.", "operationId" : "getPaymentsSettingsBillingSchedulesForBillingScheduleById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique billing schedule ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BillingScheduleSettings", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } }, "examples" : { "BillingScheduleSettings" : { "summary" : "", "value" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] } }, "components" : { "schemas" : { "ProductGetInvoiceSettingsResponseModel" : { "required" : [ "customerId", "id", "invoiceId", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "PaymentProvider" : { "type" : "string", "example" : "STRIPE", "enum" : [ "STRIPE", "GOCARDLESS", "NONE" ] }, "ProductGetCustomerSettingsResponseModel" : { "required" : [ "customerId", "id", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "UpdateCustomerSettingsRequestModel" : { "required" : [ "paymentProvider" ], "type" : "object", "example" : { "paymentProvider" : "STRIPE" }, "properties" : { "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "ProductUpdateCustomerSettingsResponseModel" : { "required" : [ "customerId", "id", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "CreateInvoiceSettingsRequestModel" : { "required" : [ "invoiceId", "paymentProvider" ], "type" : "object", "example" : { "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer ID.", "nullable" : true, "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "ProductCreateInvoiceSettingsResponseModel" : { "required" : [ "customerId", "id", "invoiceId", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "AccountPaymentSettings" : { "required" : [ "failureNotifications", "id" ], "type" : "object", "example" : { "id" : "e095e00f-36af-44c9-8c53-3e25677ce8ce", "failureNotifications" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" } }, "properties" : { "id" : { "type" : "string", "description" : "The ID of the account's payment settings", "example" : "e095e00f-36af-44c9-8c53-3e25677ce8ce" }, "failureNotifications" : { "$ref" : "#/components/schemas/PaymentFailureNotifications" } } }, "PaymentFailureNotifications" : { "required" : [ "customerNotifications", "merchantNotifications" ], "type" : "object", "description" : "The failure notification settings for the account", "example" : { "merchantNotifications" : "SEND_NOTIFICATIONS", "customerNotifications" : "SEND_NOTIFICATIONS" }, "properties" : { "merchantNotifications" : { "description" : "The payment failure notification settings for the merchant account", "$ref" : "#/components/schemas/PaymentFailureNotificationOptions" }, "customerNotifications" : { "description" : "The payment failure notification settings for the end-customers", "$ref" : "#/components/schemas/PaymentFailureNotificationOptions" } } }, "PaymentFailureNotificationOptions" : { "type" : "string", "example" : "SEND_NOTIFICATIONS", "enum" : [ "SEND_NOTIFICATIONS", "DO_NOT_SEND_NOTIFICATIONS" ] }, "UpdateInvoiceSettingsRequestModel" : { "required" : [ "paymentProvider" ], "type" : "object", "example" : { "paymentProvider" : "STRIPE" }, "properties" : { "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "ProductUpdateInvoiceSettingsResponseModel" : { "required" : [ "customerId", "id", "invoiceId", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "UpdateBillingScheduleSettingsRequestModel" : { "required" : [ "paymentProvider" ], "type" : "object", "example" : { "paymentProvider" : "STRIPE", "autoCharge" : true }, "properties" : { "paymentProvider" : { "description" : "Payment provider", "$ref" : "#/components/schemas/PaymentProvider" }, "autoCharge" : { "type" : "boolean", "description" : "Automatically collect this payment if payment details are available", "nullable" : true, "example" : true } } }, "BillingScheduleSettings" : { "required" : [ "autoCharge", "billingScheduleId", "id", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Unique Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "billingScheduleId" : { "type" : "string", "description" : "Unique payment provider ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider", "$ref" : "#/components/schemas/PaymentProvider" }, "autoCharge" : { "type" : "boolean", "description" : "Automatically collect payments if payment details are available", "example" : true } } }, "CreateCustomerSettingsRequestModel" : { "required" : [ "customerId", "paymentProvider" ], "type" : "object", "example" : { "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "customerId" : { "type" : "string", "description" : "Customer Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "ProductCreateCustomerSettingsResponseModel" : { "required" : [ "customerId", "id", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "UpdateStripeCollectionSettingsRequest" : { "type" : "object", "example" : { "enableAutomaticPayments" : false, "autoEnableStripePayments" : true, "retryAnchor" : "DUE_DATE", "retryOffsetDays" : [ 0, 7, 14 ] }, "properties" : { "enableAutomaticPayments" : { "type" : "boolean", "description" : "Whether to automatically collect payments by default if payment details are available", "nullable" : true, "example" : false }, "autoEnableStripePayments" : { "type" : "boolean", "description" : "Whether to automatically enable Stripe payments for new billing schedules", "nullable" : true, "example" : true }, "retryAnchor" : { "description" : "The invoice date that retry offsets are counted from. Null disables automatic retries.", "nullable" : true, "$ref" : "#/components/schemas/RetryAnchor" }, "retryOffsetDays" : { "type" : "array", "description" : "Days after the anchor date on which to re-attempt collection, e.g. [0, 7, 14]", "nullable" : true, "example" : [ 0, 7, 14 ], "items" : { "type" : "integer" } } } }, "RetryAnchor" : { "type" : "string", "example" : "DUE_DATE", "enum" : [ "SENT_DATE", "DUE_DATE" ] }, "StripeCollectionSettings" : { "required" : [ "autoEnableStripePayments", "enableAutomaticPayments", "id", "retryOffsetDays", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c", "sequenceAccountId" : "683fe518-60c8-429f-9320-8aa7efc20bcc", "enableAutomaticPayments" : true, "autoEnableStripePayments" : false, "retryOffsetDays" : [ ] }, "properties" : { "id" : { "type" : "string", "example" : "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c" }, "sequenceAccountId" : { "type" : "string", "example" : "683fe518-60c8-429f-9320-8aa7efc20bcc" }, "enableAutomaticPayments" : { "type" : "boolean", "description" : "Whether to automatically collect payments by default if payment details are available", "example" : true }, "autoEnableStripePayments" : { "type" : "boolean", "description" : "Whether to automatically enable Stripe payments for new billing schedules", "example" : false }, "retryOffsetDays" : { "type" : "array", "description" : "Days after the anchor date on which to re-attempt collection, e.g. [0, 7, 14]", "example" : [ ], "items" : { "type" : "integer" } } } }, "UpdateAccountPaymentSettingsRequest" : { "required" : [ "failureNotifications" ], "type" : "object", "example" : { "failureNotifications" : { "merchantNotifications" : "DO_NOT_SEND_NOTIFICATIONS", "customerNotifications" : "DO_NOT_SEND_NOTIFICATIONS" } }, "properties" : { "failureNotifications" : { "$ref" : "#/components/schemas/PaymentFailureNotifications" } } }, "ProductGetInvoiceSettingsForInvoiceResponseModel" : { "required" : [ "id", "invoiceId", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "CreateBillingScheduleSettingsRequestModel" : { "required" : [ "billingScheduleId", "paymentProvider" ], "type" : "object", "example" : { "billingScheduleId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE", "autoCharge" : true }, "properties" : { "billingScheduleId" : { "type" : "string", "description" : "Unique payment provider ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider", "$ref" : "#/components/schemas/PaymentProvider" }, "autoCharge" : { "type" : "boolean", "description" : "Automatically collect this payment if payment details are available", "nullable" : true, "example" : true } } }, "ProductDeleteCustomerSettingsResponseModel" : { "required" : [ "customerId", "id", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the customer.", "$ref" : "#/components/schemas/PaymentProvider" } } }, "ProductDeleteInvoiceSettingsResponseModel" : { "required" : [ "customerId", "id", "invoiceId", "paymentProvider", "sequenceAccountId" ], "type" : "object", "example" : { "id" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "sequenceAccountId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "invoiceId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "customerId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "paymentProvider" : "STRIPE" }, "properties" : { "id" : { "type" : "string", "description" : "Unique payment provider id.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "invoiceId" : { "type" : "string", "description" : "Invoice ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "customerId" : { "type" : "string", "description" : "Customer ID.", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "paymentProvider" : { "description" : "Payment provider for the invoice.", "$ref" : "#/components/schemas/PaymentProvider" } } } }, "requestBodies" : { }, "securitySchemes" : { } } }