{ "uuid": "2e268d41-49f0-47ee-adf6-0d312ed5805e", "lastMigration": 29, "name": "Stripe API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "5679cb22-3d0c-4589-b16f-e73234fa72ce", "documentation": "

Initiate 3D Secure authentication.

", "method": "post", "endpoint": "v1/3d_secure", "responses": [ { "uuid": "fa9ad8a6-d1d7-48c2-93c1-474036379b14", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "17b12c77-59fa-4fdd-958c-45e93cc9174a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "008df469-c5fe-4c55-9c3d-90b930ccf7ae", "documentation": "

Retrieves a 3D Secure object.

", "method": "get", "endpoint": "v1/3d_secure/:three_d_secure", "responses": [ { "uuid": "3df26d2f-c6ae-4e92-8039-9cd758b56153", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ddea6d8d-8fb1-4664-b32a-657204a45cee", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3eb313f1-dd45-4292-be5e-a07c7be34a01", "documentation": "

With Connect, you can delete accounts you manage.

\n\n

Accounts created using test-mode keys can be deleted at any time. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

", "method": "delete", "endpoint": "v1/account", "responses": [ { "uuid": "8f24f6f9-fd59-49bb-9567-cc66173cd57f", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "cfe06f02-7172-4326-80b3-62f1c556979e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7610f787-1faa-49be-88ca-34138937daa4", "documentation": "

Retrieves the details of an account.

", "method": "get", "endpoint": "v1/account", "responses": [ { "uuid": "f388419a-ae7c-4905-8b96-d3c717befa0f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "90e218ab-7216-43ad-b4bd-ee95e0d4f7d2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "872701e6-99e6-4cfc-9033-dec688c79052", "documentation": "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

\n\n

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

", "method": "post", "endpoint": "v1/account", "responses": [ { "uuid": "b2beb390-1a2b-44c5-990f-5ce8edbeb606", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b64750bd-b2d0-49a0-92ae-da5e8c262406", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "607c34ff-39dc-407e-8ed6-544510ed3342", "documentation": "

Create an external account for a given account.

", "method": "post", "endpoint": "v1/account/bank_accounts", "responses": [ { "uuid": "8ca085f9-6cd8-4fdf-941b-eed705ae9039", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "63c3db8a-739d-4b4a-82cb-426caaf46f0b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1272a404-4989-4135-910d-d2e605eff561", "documentation": "

Delete a specified external account for a given account.

", "method": "delete", "endpoint": "v1/account/bank_accounts/:id", "responses": [ { "uuid": "04a8885d-c4ae-40e5-845d-f519b06b87ce", "body": "{\n \"currency\": \"\",\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bank_account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3a9f708a-dacf-473b-aadf-74395b5fb1fa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8e8fb5f-33ed-4f94-871e-15f7baf4b301", "documentation": "

Retrieve a specified external account for a given account.

", "method": "get", "endpoint": "v1/account/bank_accounts/:id", "responses": [ { "uuid": "5c2bb5f6-1e62-42fb-baf9-9c25a854281c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4f837f0a-ed66-4063-9088-02a8dc17743e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2924dcb8-7b7e-4ed9-b074-68f42116fcf8", "documentation": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

", "method": "post", "endpoint": "v1/account/bank_accounts/:id", "responses": [ { "uuid": "6d6ff073-ea6d-4f9c-9284-e799da551c58", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3fec8a9d-61a8-492c-8e3f-58dc7c7200a5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba21a72c-f225-40e6-97bc-1363e3556c0d", "documentation": "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

", "method": "get", "endpoint": "v1/account/capabilities", "responses": [ { "uuid": "88a9a3d0-7f86-40ed-86f8-51ade7ced724", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c1847d31-60fa-4728-8c5f-394ba8dca1dd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f4c96581-3893-40c8-80bf-0b78257e5841", "documentation": "

Retrieves information about the specified Account Capability.

", "method": "get", "endpoint": "v1/account/capabilities/:capability", "responses": [ { "uuid": "89db4540-0877-4a27-9240-2d99f4b4f8fd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7dcd1719-2c17-465d-9791-75b00aab8200", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0fd3ca9c-45ea-40a7-bcd5-a1c6a4b44233", "documentation": "

Updates an existing Account Capability.

", "method": "post", "endpoint": "v1/account/capabilities/:capability", "responses": [ { "uuid": "3994e802-34a9-4977-bfa1-f36b55bf96c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ca8cec6f-4104-46c8-b0c4-6434bf9602b1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "683d6fd2-41bd-45c4-a322-14d7206a437d", "documentation": "

List external accounts for an account.

", "method": "get", "endpoint": "v1/account/external_accounts", "responses": [ { "uuid": "a433765d-cb84-479e-9747-6185536628ac", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7624e064-eb75-41fb-a0b9-6c488358d399", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "33506794-d45d-4303-ac2e-684d4c033485", "documentation": "

Create an external account for a given account.

", "method": "post", "endpoint": "v1/account/external_accounts", "responses": [ { "uuid": "aaa3c4f4-c867-45c1-b893-10cc62f6e154", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "dd41621a-f506-42aa-ad48-1847e05e314d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b15e9954-59f5-4399-87d2-5bd3dd64e47a", "documentation": "

Delete a specified external account for a given account.

", "method": "delete", "endpoint": "v1/account/external_accounts/:id", "responses": [ { "uuid": "213f0402-ee19-448a-8631-902c6cdb4ff0", "body": "{\n \"currency\": \"\",\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bank_account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b49d69e0-c787-4140-a793-722e8fa0ac36", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43f7fccc-9085-4528-ae86-0078452ad509", "documentation": "

Retrieve a specified external account for a given account.

", "method": "get", "endpoint": "v1/account/external_accounts/:id", "responses": [ { "uuid": "bdfd6427-466a-42cf-b817-86903802b7f1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "23171365-20d4-4048-b931-051f9ea0abbe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d81569f-697e-4b01-a085-45b718adb2e8", "documentation": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

", "method": "post", "endpoint": "v1/account/external_accounts/:id", "responses": [ { "uuid": "0b231147-85e1-42e9-a47f-09b7f095a2b5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1ca2d4d1-a356-4ed4-bb91-245e7a8b3422", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ff6091f-5681-40e9-96d1-a14dc19b276d", "documentation": "

Creates a single-use login link for an Express account to access their Stripe dashboard.

\n\n

You may only create login links for Express accounts connected to your platform.

", "method": "post", "endpoint": "v1/account/login_links", "responses": [ { "uuid": "c07db632-7bd3-4c98-b161-c55d1ef1799c", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"object\": \"{{oneOf (array 'login_link')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9eda28f9-5aac-440b-8c84-bcc0ee2611d8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52c2198e-912e-40b8-9569-3670713d4226", "documentation": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "method": "get", "endpoint": "v1/account/people", "responses": [ { "uuid": "700bcc5b-c7c4-4573-ade3-450ebfb0e71c", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "304cc9ca-69e2-4279-9fca-5367967699e4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e33a79d7-d3fb-477d-a0a8-4a66ef56176b", "documentation": "

Creates a new person.

", "method": "post", "endpoint": "v1/account/people", "responses": [ { "uuid": "02e24fd9-ad0f-4bb9-9e0b-b58d55545bea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "082471ce-f44b-4704-adaf-34dd91d4f6e4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e0dff2ee-4de1-4734-b3b6-3f7e02d7fcce", "documentation": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "method": "delete", "endpoint": "v1/account/people/:person", "responses": [ { "uuid": "89dd914e-1a0f-4f47-91f3-668a921c980f", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'person')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "33e8d896-d42e-445f-aeba-78f87758b3c1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dba424dc-966a-48d4-80b6-3ee8dfdde18e", "documentation": "

Retrieves an existing person.

", "method": "get", "endpoint": "v1/account/people/:person", "responses": [ { "uuid": "36827bc2-0bbb-436b-a353-27c08713e536", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f575269d-7b0b-4753-b4cf-dd55e6dac6df", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5141c9a5-ecf2-4056-a19a-4ca01f102a84", "documentation": "

Updates an existing person.

", "method": "post", "endpoint": "v1/account/people/:person", "responses": [ { "uuid": "300f2673-6d42-437d-94ec-754bdcc6d65d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0fefbc07-bf79-4b69-9f09-77f46a88344d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "00894be2-8d76-4dfe-8287-25e5eced9719", "documentation": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "method": "get", "endpoint": "v1/account/persons", "responses": [ { "uuid": "47118747-e3a3-412c-94ce-a9967bcd1bdc", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "13df2f61-3d83-49af-904e-5b58e46f560d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f1521d13-bf9b-4aca-802e-619baffe22ed", "documentation": "

Creates a new person.

", "method": "post", "endpoint": "v1/account/persons", "responses": [ { "uuid": "0aec97f9-115e-4852-b132-9031ba4e0e85", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "166e67b5-58fa-42e1-b8e6-f944f0f48a83", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d1abdf5-f82b-4009-9f82-ef4a4e6635af", "documentation": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "method": "delete", "endpoint": "v1/account/persons/:person", "responses": [ { "uuid": "a6655b82-d75f-4dcc-b7fd-29a39bcaf238", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'person')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a7982cc4-c194-4be8-8536-3c65741467f2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9aa9fad8-932c-474d-b9f1-57f4ac895db0", "documentation": "

Retrieves an existing person.

", "method": "get", "endpoint": "v1/account/persons/:person", "responses": [ { "uuid": "abbeb638-c03c-4009-86b5-fd1b6afcfc40", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "211b5d58-804b-413f-b015-d3c4b7c0c1c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9e06b910-da7b-4c14-a2d9-45ce214abc44", "documentation": "

Updates an existing person.

", "method": "post", "endpoint": "v1/account/persons/:person", "responses": [ { "uuid": "60c0766f-fd99-4292-a6c9-613baf1a58d0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9124ded4-7b1b-42a5-93ad-2af4e49570ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21ac32af-e25a-4d96-8ac1-f3e3b69b008b", "documentation": "

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

", "method": "post", "endpoint": "v1/account_links", "responses": [ { "uuid": "95736f73-cca0-4e01-8c4d-95da9e9380b6", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"expires_at\": {{faker 'number.int' max=99999}},\n \"object\": \"{{oneOf (array 'account_link')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5de7ddc8-021d-4c94-9f1f-f877063647d8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9b21498-31bb-4171-bba2-5cad78c3daae", "documentation": "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

", "method": "get", "endpoint": "v1/accounts", "responses": [ { "uuid": "cd241c14-ec68-455a-acbd-4832f66d7f43", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ae39e46f-48d2-4590-b258-299654d31225", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "24f5762a-1d46-46f2-b655-daa749e167df", "documentation": "

With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.

", "method": "post", "endpoint": "v1/accounts", "responses": [ { "uuid": "aad4a593-1194-4d56-8b69-866c6874458e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4c5b2c92-2bd7-47f4-8b2a-695eabd35cce", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44b2fa78-11b4-4a2a-b729-c3370e3b961a", "documentation": "

With Connect, you can delete accounts you manage.

\n\n

Accounts created using test-mode keys can be deleted at any time. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

", "method": "delete", "endpoint": "v1/accounts/:account", "responses": [ { "uuid": "23ea117d-978a-4556-bbf0-c4949e980663", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "60f8d653-834b-4869-b60c-7879bd0c2777", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0f36cd7-5069-4dde-ae94-fe01597d3717", "documentation": "

Retrieves the details of an account.

", "method": "get", "endpoint": "v1/accounts/:account", "responses": [ { "uuid": "e5f2885b-12ce-451a-a2f1-e6b3bb0bf6a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bc4e3c41-1db1-4915-8c9e-1f64d935dc2b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "79d165ec-bbf0-4abd-b4fc-33d314fdab5c", "documentation": "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

\n\n

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

", "method": "post", "endpoint": "v1/accounts/:account", "responses": [ { "uuid": "1d7cd404-1b87-4a97-ba52-c7e01b990887", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "83a1de34-02fc-44be-9b63-cf3fbc4d9eb5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8531537-ce30-433d-8afa-460ceed17cf8", "documentation": "

Create an external account for a given account.

", "method": "post", "endpoint": "v1/accounts/:account/bank_accounts", "responses": [ { "uuid": "ca43efd3-1125-4955-92d1-c07ff43b17fa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1399c608-37f9-4887-acd9-0fdeac4ab6d6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e96b63b3-aa84-4e50-8931-59b223fa5568", "documentation": "

Delete a specified external account for a given account.

", "method": "delete", "endpoint": "v1/accounts/:account/bank_accounts/:id", "responses": [ { "uuid": "efe7a511-9004-4c24-b702-ceb4665a622f", "body": "{\n \"currency\": \"\",\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bank_account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1b249f14-0eb6-4d58-8f92-1ea0edc4d1ec", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ca7ebbd5-1c97-431f-ae57-6eed26b4dbc4", "documentation": "

Retrieve a specified external account for a given account.

", "method": "get", "endpoint": "v1/accounts/:account/bank_accounts/:id", "responses": [ { "uuid": "113a9f5f-606d-4523-99a6-8b42da9b7a72", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a5dfb1d7-44bb-45bf-be34-0ba304b33d33", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19ecb2a6-5e08-4b2b-a99b-ff6b93e9d81b", "documentation": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

", "method": "post", "endpoint": "v1/accounts/:account/bank_accounts/:id", "responses": [ { "uuid": "e5c48e4c-fcc8-43b0-adff-e580085ccd04", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0ccd473a-23c1-4234-ae5c-bd0ce3bd4005", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b02f235c-3569-47ff-8fa5-db295b897bc4", "documentation": "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

", "method": "get", "endpoint": "v1/accounts/:account/capabilities", "responses": [ { "uuid": "cbada914-43bd-42a9-989e-932f12df21c9", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2a55bcb3-0798-4609-b979-f56d90762326", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dfd66cd0-92e5-49db-94d1-05a3b77bace8", "documentation": "

Retrieves information about the specified Account Capability.

", "method": "get", "endpoint": "v1/accounts/:account/capabilities/:capability", "responses": [ { "uuid": "7b3b6b0d-9522-48f7-a850-ee91221c7f4b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0a41279b-8a37-4469-ab1c-aeb67675461e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "72147ef3-dfca-4c46-9368-b0ea958964c0", "documentation": "

Updates an existing Account Capability.

", "method": "post", "endpoint": "v1/accounts/:account/capabilities/:capability", "responses": [ { "uuid": "c6de3ebe-a458-468d-92ec-c217226d41be", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "78f90f13-b890-48c3-b547-26b7f67ef657", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f506eb31-4354-4cee-9a99-db118b54927b", "documentation": "

List external accounts for an account.

", "method": "get", "endpoint": "v1/accounts/:account/external_accounts", "responses": [ { "uuid": "1eada156-b044-4bcc-936c-e055fa73dab8", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9b221c7c-89ca-4a26-8a97-41f533d533e7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f65c96cd-4da5-4141-ac72-7773307872f4", "documentation": "

Create an external account for a given account.

", "method": "post", "endpoint": "v1/accounts/:account/external_accounts", "responses": [ { "uuid": "a95ba031-3d14-43b2-9741-b61a8207b8fd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "eb411eac-5171-4b06-8535-3d77bcf959d1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "485011be-cad8-4aa0-93eb-b9b7339384f0", "documentation": "

Delete a specified external account for a given account.

", "method": "delete", "endpoint": "v1/accounts/:account/external_accounts/:id", "responses": [ { "uuid": "01a18cc9-1ef9-4e89-bb5a-63e3b0deb471", "body": "{\n \"currency\": \"\",\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bank_account')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "de48da1d-76bf-4c99-8f36-89e59f89f913", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "417087e2-71d4-4d8a-bfde-20186d6112c2", "documentation": "

Retrieve a specified external account for a given account.

", "method": "get", "endpoint": "v1/accounts/:account/external_accounts/:id", "responses": [ { "uuid": "b9f592a9-ecb4-4726-adae-38b62d196bb2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "77bce387-7741-49b0-870d-8296a38e3d63", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5124662c-cf8b-4dc4-b00d-327170112bd3", "documentation": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

", "method": "post", "endpoint": "v1/accounts/:account/external_accounts/:id", "responses": [ { "uuid": "d7b8fdd6-9da6-450a-b484-237e59f92b89", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d30e77db-4c4f-49c0-a32f-56fffb522cf9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2673c980-60e1-49d6-b8f2-31750e8e4ae6", "documentation": "

Creates a single-use login link for an Express account to access their Stripe dashboard.

\n\n

You may only create login links for Express accounts connected to your platform.

", "method": "post", "endpoint": "v1/accounts/:account/login_links", "responses": [ { "uuid": "53ea0482-17dd-479c-bdff-de3f6d8f4984", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"object\": \"{{oneOf (array 'login_link')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d4cdeffe-a84f-4cd8-9c2d-346abdf4703e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bedfbd84-4aca-455a-88e2-f8ff63a6119f", "documentation": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "method": "get", "endpoint": "v1/accounts/:account/people", "responses": [ { "uuid": "311b39a9-0990-4ec8-ac24-ee96b7f7e9d8", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ac3b4667-a777-4484-ba51-e8d02e63cdf8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d5a789c-5285-4b9b-8be2-88a6480f8e48", "documentation": "

Creates a new person.

", "method": "post", "endpoint": "v1/accounts/:account/people", "responses": [ { "uuid": "d482cddc-a542-4e19-88a4-b22c75441c08", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b9ae1715-6b18-4721-b61e-0adbb5e7b51a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6ee97f4f-7260-4117-b6ab-3f2f9622f808", "documentation": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "method": "delete", "endpoint": "v1/accounts/:account/people/:person", "responses": [ { "uuid": "1edff9e9-8e2a-45b0-9a44-a7a1734ee4be", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'person')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "40a1da30-e341-41ef-8c1f-940c9ba29912", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1850bb99-2fd6-41f1-b7f8-032dacd7b57f", "documentation": "

Retrieves an existing person.

", "method": "get", "endpoint": "v1/accounts/:account/people/:person", "responses": [ { "uuid": "693c1a7c-7fe3-4562-9616-2853e7688c71", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bfee9883-036a-4840-836d-087feb70c2b9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "053d7d01-d47e-44e2-a8fa-d3652c08caff", "documentation": "

Updates an existing person.

", "method": "post", "endpoint": "v1/accounts/:account/people/:person", "responses": [ { "uuid": "5ef14498-d38c-43b6-ad14-609f80c6cc87", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d078d76d-0af7-4b7a-85ed-3dc2680abaab", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c45e1c55-f147-412e-b3a6-80d5bf839b98", "documentation": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "method": "get", "endpoint": "v1/accounts/:account/persons", "responses": [ { "uuid": "9163646a-84db-4b72-8934-c8c70ed7468f", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2844247a-22da-4a90-bed3-cc4f1076b1e0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "401f3189-17cb-4724-8c49-4ae03708f78d", "documentation": "

Creates a new person.

", "method": "post", "endpoint": "v1/accounts/:account/persons", "responses": [ { "uuid": "06322c49-9255-455d-970f-57d295c99f42", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a626554a-4e49-4cf8-a8bd-8ef3b2e93bc2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c2b26f0b-7ffc-48fe-bbbe-29840b1d3aa6", "documentation": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "method": "delete", "endpoint": "v1/accounts/:account/persons/:person", "responses": [ { "uuid": "8a9dc2dd-e1ec-41ca-8446-56c61a10c676", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'person')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "08594086-01f7-4b67-9b0b-5654eca6fe2a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d45bcf67-b2ea-4b6d-a670-0d572bb636ff", "documentation": "

Retrieves an existing person.

", "method": "get", "endpoint": "v1/accounts/:account/persons/:person", "responses": [ { "uuid": "fcb11398-2f53-4484-8315-264a80e96722", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3035346d-f630-468d-91ab-b53b9562b975", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "13a35bcd-ac00-4469-89fe-a2ec8b1f8925", "documentation": "

Updates an existing person.

", "method": "post", "endpoint": "v1/accounts/:account/persons/:person", "responses": [ { "uuid": "006db8b2-aedd-4c7b-945e-90b5b84493b7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e297d573-392c-45b6-b868-645acaee617e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "925c554d-8a7b-492a-8213-4b6ece4f13ca", "documentation": "

With Connect, you may flag accounts as suspicious.

\n\n

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

", "method": "post", "endpoint": "v1/accounts/:account/reject", "responses": [ { "uuid": "6269afad-a875-46ad-bd7b-305e530dd4bc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "93ac95fa-5e37-401e-a222-3ff21c96f077", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9efba97-f1e3-4426-ba53-2ae93184965c", "documentation": "

List apple pay domains.

", "method": "get", "endpoint": "v1/apple_pay/domains", "responses": [ { "uuid": "53d24f5b-4e0e-48f0-a22c-017e1754ea4f", "body": "{\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"domain_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'apple_pay_domain')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bb1f82fb-bd85-44db-a415-e01d1eda13e7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac701c86-4552-4c76-a849-1c261dbd60bf", "documentation": "

Create an apple pay domain.

", "method": "post", "endpoint": "v1/apple_pay/domains", "responses": [ { "uuid": "05415431-a6d0-4a72-b1f1-65a6c7c0f4ff", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"domain_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'apple_pay_domain')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0b257655-300f-41e0-a563-e00726b85ac1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "150a78b4-fa55-491c-bf80-a6b70bdbae47", "documentation": "

Delete an apple pay domain.

", "method": "delete", "endpoint": "v1/apple_pay/domains/:domain", "responses": [ { "uuid": "dac269e3-f89d-47a4-a823-7880cabae983", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'apple_pay_domain')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0ad6f62a-6fe0-4787-9565-b23fe5439339", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db81636e-7b25-4d4f-af0b-62a84c70b532", "documentation": "

Retrieve an apple pay domain.

", "method": "get", "endpoint": "v1/apple_pay/domains/:domain", "responses": [ { "uuid": "c41d2fc8-de81-490b-ab87-c70f3949f5e2", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"domain_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'apple_pay_domain')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7c0e3e72-9905-4f37-a9ba-0ea6fc3d0af5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2f29adb2-3c5f-4afc-b2ba-ee3aa8960e9a", "documentation": "

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

", "method": "get", "endpoint": "v1/application_fees", "responses": [ { "uuid": "56ae636d-9111-4b1a-bb45-c0ab4592a344", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c414bf75-772b-4d7b-8abb-0b0f128129f7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aa3203a6-34c4-4690-8cec-b6c66e3699c0", "documentation": "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

", "method": "get", "endpoint": "v1/application_fees/:fee/refunds/:id", "responses": [ { "uuid": "73800b73-55b7-42e2-996a-dda1daa4ec52", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e3eb4379-1a03-4678-996d-de78857380c7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7a15a69-083f-41d6-9ee5-87021c866f58", "documentation": "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

", "method": "post", "endpoint": "v1/application_fees/:fee/refunds/:id", "responses": [ { "uuid": "445f1606-4dc6-456a-afae-ef7744bea91e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "abde2f61-aaef-44e6-91d4-38839db483cf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "878386d7-5d2a-439c-8f5d-53fac8d469e9", "documentation": "

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

", "method": "get", "endpoint": "v1/application_fees/:id", "responses": [ { "uuid": "ec3014b0-4ce3-46c0-97b5-4975f6a3a294", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bf61ab69-ea27-47cf-8eba-bf7d0773e567", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14afded1-4804-483e-8def-95d1ac3c761d", "documentation": "", "method": "post", "endpoint": "v1/application_fees/:id/refund", "responses": [ { "uuid": "ec15d80e-4cb0-4a99-aa6e-cda7475213a7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c90be74d-9f80-49ad-abcb-4620575d97d4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "13fc2b2c-5267-4d6d-9c3f-b3c614bcd339", "documentation": "

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "method": "get", "endpoint": "v1/application_fees/:id/refunds", "responses": [ { "uuid": "083ba3de-d3c4-4e3d-84b0-51acb61c9aa6", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c03d8b8d-5351-4a7e-8121-40ec26d30807", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "757bdea4-291d-4f84-bf23-de1ed295daf0", "documentation": "

Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.

\n\n

You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.

\n\n

Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.

", "method": "post", "endpoint": "v1/application_fees/:id/refunds", "responses": [ { "uuid": "cda86d18-c287-4f2e-a366-2f097dc93337", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6a57a828-0bea-40e6-98b0-40f860340a36", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc3b48c0-75d7-4fa3-9819-3fede6447b37", "documentation": "

Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.

", "method": "get", "endpoint": "v1/balance", "responses": [ { "uuid": "70ac704a-2c9f-49a8-bb06-f11e47b7e05a", "body": "{\n \"available\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"source_types\": {\n \"bank_account\": {{faker 'number.int' max=99999}},\n \"card\": {{faker 'number.int' max=99999}},\n \"fpx\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"connect_reserved\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"source_types\": {\n \"bank_account\": {{faker 'number.int' max=99999}},\n \"card\": {{faker 'number.int' max=99999}},\n \"fpx\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"instant_available\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"source_types\": {\n \"bank_account\": {{faker 'number.int' max=99999}},\n \"card\": {{faker 'number.int' max=99999}},\n \"fpx\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"issuing\": {\n \"available\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"source_types\": {\n \"bank_account\": {{faker 'number.int' max=99999}},\n \"card\": {{faker 'number.int' max=99999}},\n \"fpx\": {{faker 'number.int' max=99999}}\n }\n }\n ]\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'balance')}}\",\n \"pending\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"source_types\": {\n \"bank_account\": {{faker 'number.int' max=99999}},\n \"card\": {{faker 'number.int' max=99999}},\n \"fpx\": {{faker 'number.int' max=99999}}\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4a1e467e-ad3f-4010-a261-6f0dacd4146c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f8667f0-f17a-4ba3-b940-9f2cc0c82e67", "documentation": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", "method": "get", "endpoint": "v1/balance/history", "responses": [ { "uuid": "b7d4356c-0d30-4563-912c-1b9e53239429", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5f1f69f3-161e-4827-8667-5ad5cb918fd7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ea9f2093-a5d4-41ea-b1ed-fdc233c57df6", "documentation": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", "method": "get", "endpoint": "v1/balance/history/:id", "responses": [ { "uuid": "f4cd31c3-a88d-411f-a8cf-0f4180b6b40d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "63e8e8b5-2a0e-4875-a70f-92478e744eb2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b9d551c-17cb-471c-b278-ac43b3cf3b43", "documentation": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", "method": "get", "endpoint": "v1/balance_transactions", "responses": [ { "uuid": "cf732442-a413-4d5a-ab5c-dec7761f1da0", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "85ce5f58-aadd-4d4c-8f51-241fabf82f2f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bce5800c-2aeb-4b72-9fa8-fa5d74000b8f", "documentation": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", "method": "get", "endpoint": "v1/balance_transactions/:id", "responses": [ { "uuid": "2b8e616c-14be-473d-8e3e-3fcaead64223", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6975b653-371d-4072-91c6-d2f313af77e3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dba5034c-38a8-4d8e-88d5-a3d2946c874e", "documentation": "

Returns a list of configurations that describe the functionality of the customer portal.

", "method": "get", "endpoint": "v1/billing_portal/configurations", "responses": [ { "uuid": "07fc4d74-efec-4a03-b18b-79eb3b798e14", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"application\": \"\",\n \"business_profile\": {\n \"headline\": \"\",\n \"privacy_policy_url\": \"\",\n \"terms_of_service_url\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"default_return_url\": \"\",\n \"features\": {\n \"customer_update\": {\n \"allowed_updates\": [\n \"{{oneOf (array 'address' 'email' 'phone' 'shipping' 'tax_id')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"invoice_history\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"payment_method_update\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_cancel\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"mode\": \"{{oneOf (array 'at_period_end' 'immediately')}}\",\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n },\n \"subscription_pause\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_update\": {\n \"default_allowed_updates\": [\n \"{{oneOf (array 'price' 'promotion_code' 'quantity')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}},\n \"products\": [\n {\n \"prices\": [\n \"\"\n ],\n \"product\": \"\"\n }\n ],\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n }\n },\n \"id\": \"\",\n \"is_default\": {{faker 'datatype.boolean'}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'billing_portal.configuration')}}\",\n \"updated\": {{faker 'number.int' max=99999}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d2d58614-6dda-4bb3-bcc6-91a400d6c81a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e5f021b-9386-4843-9b28-364c5423236c", "documentation": "

Creates a configuration that describes the functionality and behavior of a PortalSession

", "method": "post", "endpoint": "v1/billing_portal/configurations", "responses": [ { "uuid": "904a6dfe-8bcc-45d8-bab5-79c351174dfb", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"application\": \"\",\n \"business_profile\": {\n \"headline\": \"\",\n \"privacy_policy_url\": \"\",\n \"terms_of_service_url\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"default_return_url\": \"\",\n \"features\": {\n \"customer_update\": {\n \"allowed_updates\": [\n \"{{oneOf (array 'address' 'email' 'phone' 'shipping' 'tax_id')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"invoice_history\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"payment_method_update\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_cancel\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"mode\": \"{{oneOf (array 'at_period_end' 'immediately')}}\",\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n },\n \"subscription_pause\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_update\": {\n \"default_allowed_updates\": [\n \"{{oneOf (array 'price' 'promotion_code' 'quantity')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}},\n \"products\": [\n {\n \"prices\": [\n \"\"\n ],\n \"product\": \"\"\n }\n ],\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n }\n },\n \"id\": \"\",\n \"is_default\": {{faker 'datatype.boolean'}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'billing_portal.configuration')}}\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a5ca6340-9042-46f1-93b6-5cd1f3a4c9c6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "140732b3-d4c7-41c6-82ea-58ae2095459c", "documentation": "

Retrieves a configuration that describes the functionality of the customer portal.

", "method": "get", "endpoint": "v1/billing_portal/configurations/:configuration", "responses": [ { "uuid": "7df1689c-0947-4a9d-aeb3-9ee4b018c579", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"application\": \"\",\n \"business_profile\": {\n \"headline\": \"\",\n \"privacy_policy_url\": \"\",\n \"terms_of_service_url\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"default_return_url\": \"\",\n \"features\": {\n \"customer_update\": {\n \"allowed_updates\": [\n \"{{oneOf (array 'address' 'email' 'phone' 'shipping' 'tax_id')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"invoice_history\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"payment_method_update\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_cancel\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"mode\": \"{{oneOf (array 'at_period_end' 'immediately')}}\",\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n },\n \"subscription_pause\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_update\": {\n \"default_allowed_updates\": [\n \"{{oneOf (array 'price' 'promotion_code' 'quantity')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}},\n \"products\": [\n {\n \"prices\": [\n \"\"\n ],\n \"product\": \"\"\n }\n ],\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n }\n },\n \"id\": \"\",\n \"is_default\": {{faker 'datatype.boolean'}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'billing_portal.configuration')}}\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d394fa9c-2107-4078-ac39-5f50c1323e41", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b9a27d1-3f06-449c-a4a6-386e089386cd", "documentation": "

Updates a configuration that describes the functionality of the customer portal.

", "method": "post", "endpoint": "v1/billing_portal/configurations/:configuration", "responses": [ { "uuid": "c2b6878b-6d9b-417a-8cb6-18c7d2594714", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"application\": \"\",\n \"business_profile\": {\n \"headline\": \"\",\n \"privacy_policy_url\": \"\",\n \"terms_of_service_url\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"default_return_url\": \"\",\n \"features\": {\n \"customer_update\": {\n \"allowed_updates\": [\n \"{{oneOf (array 'address' 'email' 'phone' 'shipping' 'tax_id')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"invoice_history\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"payment_method_update\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_cancel\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"mode\": \"{{oneOf (array 'at_period_end' 'immediately')}}\",\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n },\n \"subscription_pause\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"subscription_update\": {\n \"default_allowed_updates\": [\n \"{{oneOf (array 'price' 'promotion_code' 'quantity')}}\"\n ],\n \"enabled\": {{faker 'datatype.boolean'}},\n \"products\": [\n {\n \"prices\": [\n \"\"\n ],\n \"product\": \"\"\n }\n ],\n \"proration_behavior\": \"{{oneOf (array 'always_invoice' 'create_prorations' 'none')}}\"\n }\n },\n \"id\": \"\",\n \"is_default\": {{faker 'datatype.boolean'}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'billing_portal.configuration')}}\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6e6d0747-4a90-44f1-854e-90e42ee7cfbc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "537f9358-15bf-4a6f-8ffa-a5023e5f68b7", "documentation": "

Creates a session of the customer portal.

", "method": "post", "endpoint": "v1/billing_portal/sessions", "responses": [ { "uuid": "306fa7c7-eb65-4dc7-9352-212b50567d68", "body": "{\n \"configuration\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"customer\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"locale\": \"{{oneOf (array 'auto' 'bg' 'cs' 'da' 'de' 'el' 'en' 'en-AU' 'en-CA' 'en-GB' 'en-IE' 'en-IN' 'en-NZ' 'en-SG' 'es' 'es-419' 'et' 'fi' 'fil' 'fr' 'fr-CA' 'hr' 'hu' 'id' 'it' 'ja' 'ko' 'lt' 'lv' 'ms' 'mt' 'nb' 'nl' 'pl' 'pt' 'pt-BR' 'ro' 'ru' 'sk' 'sl' 'sv' 'th' 'tr' 'vi' 'zh' 'zh-HK' 'zh-TW')}}\",\n \"object\": \"{{oneOf (array 'billing_portal.session')}}\",\n \"on_behalf_of\": \"\",\n \"return_url\": \"\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "093df73b-54a4-4969-9b99-e2073b924e89", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac2637a7-0f7b-4a8f-ba5c-56e704ad46e0", "documentation": "

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

", "method": "get", "endpoint": "v1/bitcoin/receivers", "responses": [ { "uuid": "e0e97efc-a756-4a81-87c0-1899580fe7f1", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount_received\": {{faker 'number.int' max=99999}},\n \"bitcoin_uri\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"filled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"inbound_address\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'bitcoin_receiver')}}\",\n \"payment\": \"\",\n \"refund_address\": \"\",\n \"transactions\": {\n \"data\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bitcoin_transaction')}}\",\n \"receiver\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"uncaptured_funds\": {{faker 'datatype.boolean'}},\n \"used_for_payment\": {{faker 'datatype.boolean'}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "195db101-077d-44d7-bb22-4d1b75f49c1b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d05cb568-2c5f-4941-96f2-b92f0596cb9e", "documentation": "

Retrieves the Bitcoin receiver with the given ID.

", "method": "get", "endpoint": "v1/bitcoin/receivers/:id", "responses": [ { "uuid": "5c491e30-0b4e-4925-94d0-6e8df3401ea1", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount_received\": {{faker 'number.int' max=99999}},\n \"bitcoin_uri\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"filled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"inbound_address\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'bitcoin_receiver')}}\",\n \"payment\": \"\",\n \"refund_address\": \"\",\n \"transactions\": {\n \"data\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bitcoin_transaction')}}\",\n \"receiver\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"uncaptured_funds\": {{faker 'datatype.boolean'}},\n \"used_for_payment\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7f3a900a-50ea-4bdc-8799-fd163ca5ac1d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a8ea13a-1787-4076-86df-8bc357e554df", "documentation": "

List bitcoin transacitons for a given receiver.

", "method": "get", "endpoint": "v1/bitcoin/receivers/:receiver/transactions", "responses": [ { "uuid": "d96e145d-bed5-4056-9219-6822fded1cba", "body": "{\n \"data\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bitcoin_transaction')}}\",\n \"receiver\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6885a3b0-0e30-459f-9bd8-dad383408d06", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ac8d034-a623-4dc9-9be4-7a1930997289", "documentation": "

List bitcoin transacitons for a given receiver.

", "method": "get", "endpoint": "v1/bitcoin/transactions", "responses": [ { "uuid": "901bfe58-4344-4fc5-aca9-e6a4afcfdf95", "body": "{\n \"data\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"bitcoin_amount\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'bitcoin_transaction')}}\",\n \"receiver\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ce5250ab-1f74-47bf-a92d-44fbbd3784c2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c6f00eb9-ca9f-4e67-b36f-22fc36540796", "documentation": "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

", "method": "get", "endpoint": "v1/charges", "responses": [ { "uuid": "334e70c1-ca9a-4fca-90bf-fa8ed7832e31", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f7c58a9f-9c9b-442d-b410-5942254fa543", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2f03af7-7c2a-475f-b307-454de7d9ec63", "documentation": "

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

", "method": "post", "endpoint": "v1/charges", "responses": [ { "uuid": "4611f4ad-9714-4ecc-bf88-a80adebf1e90", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6205a568-09fa-4d82-9ab1-8e7ea939d2b1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4d037731-ee04-4521-8929-2102de35c766", "documentation": "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

", "method": "get", "endpoint": "v1/charges/:charge", "responses": [ { "uuid": "15cd04d3-7470-40be-8072-887113cb8ad2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "8bd2b7f4-20e4-4ab6-be23-04ce7b44698c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a285b49-188e-49ec-b3d0-ee45d50701f2", "documentation": "

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/charges/:charge", "responses": [ { "uuid": "9060a7ee-8b5c-4750-a584-4095b79918a5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a23a197f-9757-4219-8df7-6c5b6d31bee1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7962aad-ea49-4bcd-9000-99d332111e85", "documentation": "

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

\n\n

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

", "method": "post", "endpoint": "v1/charges/:charge/capture", "responses": [ { "uuid": "ade35007-33dd-47c8-be2d-5cbe5c88ed09", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7d629c3b-a83b-4f26-a691-46449b40583a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c6328e34-a86e-41e9-b0bf-0d8d0de4173e", "documentation": "

Retrieve a dispute for a specified charge.

", "method": "get", "endpoint": "v1/charges/:charge/dispute", "responses": [ { "uuid": "fa4fa489-5801-4437-ae2b-0039ebc02322", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5abf11ce-36f2-4f12-a0d7-6cb5252a07a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b65257f-c549-47b7-aa28-ad7a37d3fba9", "documentation": "", "method": "post", "endpoint": "v1/charges/:charge/dispute", "responses": [ { "uuid": "be95ebc2-750e-4256-9b6f-29d8acefe8b3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "98f836e6-1c55-44fb-9311-7f28f2da50a6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50b908b4-39a6-4240-809d-97670bd8cd54", "documentation": "", "method": "post", "endpoint": "v1/charges/:charge/dispute/close", "responses": [ { "uuid": "6d48ed01-5478-412d-a784-d2669507fb88", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "73753987-bd4a-46c8-8beb-b6b65580fefa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "852cee6a-3268-40ae-b075-083bb3895655", "documentation": "

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

\n\n

Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.

\n\n

Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.

", "method": "post", "endpoint": "v1/charges/:charge/refund", "responses": [ { "uuid": "b3865bdf-80bc-40f8-b23f-0e73918ec872", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "289a0a54-8ad5-4705-8487-52e1824f7539", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e48eed28-2185-4670-8715-df8b06be5ae3", "documentation": "

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "method": "get", "endpoint": "v1/charges/:charge/refunds", "responses": [ { "uuid": "2e05be3e-c720-42c3-99c9-d6fc7baedf05", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e745b454-90fb-413a-804b-de789bed7ad9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "97abdacc-5b3d-4f16-bf3e-33a5e18ada00", "documentation": "

Create a refund.

", "method": "post", "endpoint": "v1/charges/:charge/refunds", "responses": [ { "uuid": "5c144424-6627-46f9-a6a5-6ece34be0062", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bbc16468-d739-4cf4-a53c-5291a306d2a9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2050b5f7-e7f5-4084-ab50-bb2950d8a531", "documentation": "

Retrieves the details of an existing refund.

", "method": "get", "endpoint": "v1/charges/:charge/refunds/:refund", "responses": [ { "uuid": "73e0accb-c980-44ee-becd-2915f337d70d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d208c896-1546-47a8-b7ba-830a0ec38cc5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80ffe69c-016e-4b44-85fa-b842a8621a67", "documentation": "

Update a specified refund.

", "method": "post", "endpoint": "v1/charges/:charge/refunds/:refund", "responses": [ { "uuid": "7a26b52d-627e-404f-b298-3f2965c3fc01", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5e8d9ded-3c3b-49cb-8083-063aff35462f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "034368db-d17e-40ab-9003-27cee3bb61e2", "documentation": "

Returns a list of Checkout Sessions.

", "method": "get", "endpoint": "v1/checkout/sessions", "responses": [ { "uuid": "ab9d218e-1416-424e-ab22-f88e60e8d6c0", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fb82e4d7-d1c7-443a-aa3a-ac14c5d533a7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f03de91-881e-4bb4-95ae-8f99bd46aa2b", "documentation": "

Creates a Session object.

", "method": "post", "endpoint": "v1/checkout/sessions", "responses": [ { "uuid": "cf67d46a-5b6e-4cf8-9966-1a1663f281ca", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "851835f9-fc54-4088-9ad4-b6e1507f2b19", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7547f19-c066-435c-96a1-cdd3c239fd0f", "documentation": "

Retrieves a Session object.

", "method": "get", "endpoint": "v1/checkout/sessions/:session", "responses": [ { "uuid": "b82c88fd-64d7-4304-9407-ed41e9788831", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2c3a7904-58d6-4c53-828c-a5e1801533ba", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ab9278bd-35ed-4a9e-8527-0f17363f1732", "documentation": "

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/checkout/sessions/:session/line_items", "responses": [ { "uuid": "3cbd2e02-a7ab-439e-907f-7c91a2ef0ef7", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3e806414-a9d3-457c-87d2-bf99379d0270", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0f36bd4d-dafc-4e45-9132-65bac6e729af", "documentation": "

Lists all Country Spec objects available in the API.

", "method": "get", "endpoint": "v1/country_specs", "responses": [ { "uuid": "9286519a-0637-4fcd-baaf-cf0e9206a0f5", "body": "{\n \"data\": [\n {\n \"default_currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'country_spec')}}\",\n \"supported_bank_account_currencies\": {},\n \"supported_payment_currencies\": [\n \"\"\n ],\n \"supported_payment_methods\": [\n \"\"\n ],\n \"supported_transfer_countries\": [\n \"\"\n ],\n \"verification_fields\": {\n \"company\": {\n \"additional\": [\n \"\"\n ],\n \"minimum\": [\n \"\"\n ]\n },\n \"individual\": {\n \"additional\": [\n \"\"\n ],\n \"minimum\": [\n \"\"\n ]\n }\n }\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "098dbfe0-7793-4d99-b041-42b61f1ff971", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64ba04a5-1d3c-4d58-abe9-d5a70d46ec42", "documentation": "

Returns a Country Spec for a given Country code.

", "method": "get", "endpoint": "v1/country_specs/:country", "responses": [ { "uuid": "b8f267de-3a19-4154-9ba6-cd1d5d20a10c", "body": "{\n \"default_currency\": \"\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'country_spec')}}\",\n \"supported_bank_account_currencies\": {},\n \"supported_payment_currencies\": [\n \"\"\n ],\n \"supported_payment_methods\": [\n \"\"\n ],\n \"supported_transfer_countries\": [\n \"\"\n ],\n \"verification_fields\": {\n \"company\": {\n \"additional\": [\n \"\"\n ],\n \"minimum\": [\n \"\"\n ]\n },\n \"individual\": {\n \"additional\": [\n \"\"\n ],\n \"minimum\": [\n \"\"\n ]\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a4d98909-6d88-449a-964f-054166e4aebb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cf99431e-e2b8-4c26-aec1-a8b2719945c8", "documentation": "

Returns a list of your coupons.

", "method": "get", "endpoint": "v1/coupons", "responses": [ { "uuid": "8200529a-e04b-4fc0-91d8-94341f0b6058", "body": "{\n \"data\": [\n {\n \"amount_off\": {{faker 'number.int' max=99999}},\n \"applies_to\": {\n \"products\": [\n \"\"\n ]\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"duration\": \"{{oneOf (array 'forever' 'once' 'repeating')}}\",\n \"duration_in_months\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"max_redemptions\": {{faker 'number.int' max=99999}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'coupon')}}\",\n \"percent_off\": {{faker 'number.int' max=99999}},\n \"redeem_by\": {{faker 'number.int' max=99999}},\n \"times_redeemed\": {{faker 'number.int' max=99999}},\n \"valid\": {{faker 'datatype.boolean'}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9bb1bf4d-33bb-45b1-8b16-9e957726f962", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "04f24aff-06ed-4e7c-bc6b-89abd57c0a38", "documentation": "

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

\n\n

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

", "method": "post", "endpoint": "v1/coupons", "responses": [ { "uuid": "3131873f-ad92-4618-bc58-3d5456381901", "body": "{\n \"amount_off\": {{faker 'number.int' max=99999}},\n \"applies_to\": {\n \"products\": [\n \"\"\n ]\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"duration\": \"{{oneOf (array 'forever' 'once' 'repeating')}}\",\n \"duration_in_months\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"max_redemptions\": {{faker 'number.int' max=99999}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'coupon')}}\",\n \"percent_off\": {{faker 'number.int' max=99999}},\n \"redeem_by\": {{faker 'number.int' max=99999}},\n \"times_redeemed\": {{faker 'number.int' max=99999}},\n \"valid\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "99353e4c-7d31-4638-b575-566c6cf92c72", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d384f356-0d2d-4687-9427-2a54634aae8e", "documentation": "

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

", "method": "delete", "endpoint": "v1/coupons/:coupon", "responses": [ { "uuid": "f6d3c8c4-ab02-4fd3-a707-de10aff61c1e", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'coupon')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "63bb3224-29a4-4d0a-aeb1-c7fcbd51661a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c6f6757-8131-4ca1-9330-3a74b057d92e", "documentation": "

Retrieves the coupon with the given ID.

", "method": "get", "endpoint": "v1/coupons/:coupon", "responses": [ { "uuid": "6cfc238c-ed58-4bca-b50a-4cd857d71b09", "body": "{\n \"amount_off\": {{faker 'number.int' max=99999}},\n \"applies_to\": {\n \"products\": [\n \"\"\n ]\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"duration\": \"{{oneOf (array 'forever' 'once' 'repeating')}}\",\n \"duration_in_months\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"max_redemptions\": {{faker 'number.int' max=99999}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'coupon')}}\",\n \"percent_off\": {{faker 'number.int' max=99999}},\n \"redeem_by\": {{faker 'number.int' max=99999}},\n \"times_redeemed\": {{faker 'number.int' max=99999}},\n \"valid\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d5eb363e-2cfe-4bec-b248-f8b63c5ae3b3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48cac8ad-d612-4da4-92fc-31d4e5fba7f3", "documentation": "

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

", "method": "post", "endpoint": "v1/coupons/:coupon", "responses": [ { "uuid": "a07eb368-06ee-46ec-8ca8-8d5a5e37fb7a", "body": "{\n \"amount_off\": {{faker 'number.int' max=99999}},\n \"applies_to\": {\n \"products\": [\n \"\"\n ]\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"duration\": \"{{oneOf (array 'forever' 'once' 'repeating')}}\",\n \"duration_in_months\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"max_redemptions\": {{faker 'number.int' max=99999}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'coupon')}}\",\n \"percent_off\": {{faker 'number.int' max=99999}},\n \"redeem_by\": {{faker 'number.int' max=99999}},\n \"times_redeemed\": {{faker 'number.int' max=99999}},\n \"valid\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4a80ba18-9507-4a71-abae-9f0428a749a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ae9395fe-c4dc-44db-bfc0-81692f9e6793", "documentation": "

Returns a list of credit notes.

", "method": "get", "endpoint": "v1/credit_notes", "responses": [ { "uuid": "a47f481c-d031-4c03-b469-31c6d6655a7f", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a97c43b2-9608-4539-a0c6-923d3888c3c7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "451cf404-df8e-467f-94d9-e83a276e8083", "documentation": "

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces\nits amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result\nin any combination of the following:

\n\n\n\n

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

\n\n

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount\nor post_payment_credit_notes_amount depending on its status at the time of credit note creation.

", "method": "post", "endpoint": "v1/credit_notes", "responses": [ { "uuid": "2a67fe14-5244-47c1-ae43-ce920fa84149", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "08a4acb6-9445-414e-b40e-75b5920f97fa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2fb4f58c-31fb-483a-97d0-c4551f354fe7", "documentation": "

Get a preview of a credit note without creating it.

", "method": "get", "endpoint": "v1/credit_notes/preview", "responses": [ { "uuid": "9263ebad-6b1b-40a4-8c87-d312f7ed4902", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b84d9130-d3ac-4e61-8ce9-c427eef87e84", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a989e8d1-f050-4c63-b302-ff466b63599f", "documentation": "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/credit_notes/preview/lines", "responses": [ { "uuid": "76939780-2a9e-4c0d-94d0-ff0a8550c8fe", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "491d2a1e-7b40-46b5-aad2-50a91ce657ca", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "11373ff6-df7e-4e30-97d0-742225c05793", "documentation": "

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/credit_notes/:credit_note/lines", "responses": [ { "uuid": "e3890f05-c6b2-4311-81d6-49c0695b8020", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7ad769c0-8a3f-4ca3-befd-c1fef540c87f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8f526133-c4a2-4957-92c8-5ece74fcbc56", "documentation": "

Retrieves the credit note object with the given identifier.

", "method": "get", "endpoint": "v1/credit_notes/:id", "responses": [ { "uuid": "ce99c132-d7f4-4524-85eb-533575d4d997", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "807f1d1d-9eff-4eb5-aa3f-20bf01c5e934", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34eece1c-3a28-434f-a301-840f77c1b240", "documentation": "

Updates an existing credit note.

", "method": "post", "endpoint": "v1/credit_notes/:id", "responses": [ { "uuid": "55657566-4281-4d21-b91d-5ba84f8c6235", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "72602a92-8b29-4d47-a2a8-42115b85b066", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84662484-58a0-439a-98b6-60e3f0f63b2d", "documentation": "

Marks a credit note as void. Learn more about voiding credit notes.

", "method": "post", "endpoint": "v1/credit_notes/:id/void", "responses": [ { "uuid": "5eca1b12-234b-4c22-b6cc-de7b2c07fcf3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "df2612b2-f625-4e55-93f6-0d7fc33c3e85", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e56c8ee-a720-4100-81c3-8bc8d66ab411", "documentation": "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

", "method": "get", "endpoint": "v1/customers", "responses": [ { "uuid": "f4ba47a9-994f-4407-8603-973e013bf036", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5b483795-5f93-42a7-8cf5-11a8d1691b8b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7e19067-159f-4751-a9e5-dc61a70b23ae", "documentation": "

Creates a new customer object.

", "method": "post", "endpoint": "v1/customers", "responses": [ { "uuid": "d0ed8aec-f036-46b3-be0c-d88c220dd1e1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "174dad3c-98c9-44cc-b279-ae56a54b4ca3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a454b07-bd4b-41dc-ba78-773586c14d77", "documentation": "

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

", "method": "delete", "endpoint": "v1/customers/:customer", "responses": [ { "uuid": "8a1ae094-c2b6-45c4-af33-962d8e94a8a2", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'customer')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "509339bc-16ea-4acd-9be0-34daf8104d9c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd23a4bc-9a30-4eab-b8b3-fe989242ceac", "documentation": "

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

", "method": "get", "endpoint": "v1/customers/:customer", "responses": [ { "uuid": "7fc7424f-71b7-47b7-9ca9-9516e0d62de4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "424c12ae-3f9d-4e99-ad2d-e0b6903520a2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a042872-0c89-468a-b316-c63c73c5e513", "documentation": "

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

\n\n

This request accepts mostly the same arguments as the customer creation call.

", "method": "post", "endpoint": "v1/customers/:customer", "responses": [ { "uuid": "a828e737-3ea3-4d1a-bcd0-e746dd0cec5e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4d298a88-508a-402c-8bca-234257acbb2c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4fb5c81-4e63-4830-b927-5764a2a3bcea", "documentation": "

Returns a list of transactions that updated the customer’s balances.

", "method": "get", "endpoint": "v1/customers/:customer/balance_transactions", "responses": [ { "uuid": "038e7260-e0a5-460e-a0cb-bd4ae7260f0d", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fb434c2e-6e3b-4378-9715-78d069349383", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "38da2000-d516-4b5d-bd33-4e2764ddf43d", "documentation": "

Creates an immutable transaction that updates the customer’s credit balance.

", "method": "post", "endpoint": "v1/customers/:customer/balance_transactions", "responses": [ { "uuid": "d40f30f0-d61f-4eb7-83e1-1ab00bfef2ea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f4ec8049-13bf-4e41-8a72-e7d17f0f8667", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "329128e9-69e5-480b-aced-ac24e162257e", "documentation": "

Retrieves a specific customer balance transaction that updated the customer’s balances.

", "method": "get", "endpoint": "v1/customers/:customer/balance_transactions/:transaction", "responses": [ { "uuid": "bbaed4c0-08b3-4dc9-b658-4e9946a8f75e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "31234422-090f-4a1d-91c9-7b3fdc8e77ea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eeeb5eb0-acb8-4da5-b367-3bb712f08db5", "documentation": "

Most credit balance transaction fields are immutable, but you may update its description and metadata.

", "method": "post", "endpoint": "v1/customers/:customer/balance_transactions/:transaction", "responses": [ { "uuid": "4b9bd824-2770-48ac-a024-03db491859ea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "11d43a20-fa8e-4b91-a066-b97a983c739b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6a622cc-b087-4514-aeb5-7cb96e81f261", "documentation": "

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

", "method": "get", "endpoint": "v1/customers/:customer/bank_accounts", "responses": [ { "uuid": "b0012cc9-3253-491d-93e6-5aa37629199e", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "25281468-6c16-4bd2-a0b5-eee6372e5404", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7fccd07-d1c0-482a-81c9-3263fe17f4df", "documentation": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "method": "post", "endpoint": "v1/customers/:customer/bank_accounts", "responses": [ { "uuid": "61af7a15-46ad-4569-bf48-caf8b83647ca", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "65bdf33b-9932-486e-a379-9d818f62aa3b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64e9ce6f-ca65-41ee-91e5-d9bc97cdf825", "documentation": "

Delete a specified source for a given customer.

", "method": "delete", "endpoint": "v1/customers/:customer/bank_accounts/:id", "responses": [ { "uuid": "b68ce3ee-f723-4b5c-a208-7210fab115b3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "48755c26-7f79-46bd-88f3-ef83ba2303f6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b83ebc69-9e92-4a06-8016-2dc4cb8affa3", "documentation": "

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

", "method": "get", "endpoint": "v1/customers/:customer/bank_accounts/:id", "responses": [ { "uuid": "f9fc8176-abfe-4b7a-a9ef-9d2d0807091f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f94d9619-3deb-49b2-bcfc-a7db9fce91bf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b8ae5be-e7c6-4f12-8621-3ffc9de41636", "documentation": "

Update a specified source for a given customer.

", "method": "post", "endpoint": "v1/customers/:customer/bank_accounts/:id", "responses": [ { "uuid": "82f91d5f-1bdf-4f00-ae64-fbc064fbce5e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4440370f-928a-4d3f-9fa0-a6cb70f155d1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "383a52dc-7e55-469a-a3f2-1a18bb81ce87", "documentation": "

Verify a specified bank account for a given customer.

", "method": "post", "endpoint": "v1/customers/:customer/bank_accounts/:id/verify", "responses": [ { "uuid": "ebc360da-07a0-4d38-a96e-cbd29d0eb6f0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2312671d-925e-49b2-85a3-c5f5480d6f73", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "00eb42c5-51db-42cd-b71c-8cc3ba62228f", "documentation": "

You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the Customer object.\nIf you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

", "method": "get", "endpoint": "v1/customers/:customer/cards", "responses": [ { "uuid": "ef9039e9-a557-477c-b6f3-6f1767c834bb", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "470ed742-93bb-4846-82f4-7d55feeb4e4e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ddf7eb0-5398-46a5-b207-1691830790f4", "documentation": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "method": "post", "endpoint": "v1/customers/:customer/cards", "responses": [ { "uuid": "95d27a3e-bc27-4424-ada2-3b8cadff4682", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "cfa3bff7-f0b6-4180-9865-33c4a823925a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99ec6173-3ce3-4f2a-8377-05f5ad04c8f2", "documentation": "

Delete a specified source for a given customer.

", "method": "delete", "endpoint": "v1/customers/:customer/cards/:id", "responses": [ { "uuid": "275cdecd-14dc-4480-b8a1-c284686a38e4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6d086e72-84cb-4812-b30c-cbb8f3815bcd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82ed05db-3c8f-4ab6-99c4-a0e619630e14", "documentation": "

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

", "method": "get", "endpoint": "v1/customers/:customer/cards/:id", "responses": [ { "uuid": "63e95a2f-bbbf-49a5-80e5-8c2eea29152d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "de0d9047-209c-49c3-bf8d-a7a914a23b8f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2209e8e3-6640-46eb-ab5c-5fe9831d44b8", "documentation": "

Update a specified source for a given customer.

", "method": "post", "endpoint": "v1/customers/:customer/cards/:id", "responses": [ { "uuid": "88d9a278-0013-49a0-bf24-be8b1e377d5b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0df4e7f5-5fbf-40b4-97b9-fa1947eeb999", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b7d617ed-04f6-45b2-a43d-31ac70d3b664", "documentation": "

Removes the currently applied discount on a customer.

", "method": "delete", "endpoint": "v1/customers/:customer/discount", "responses": [ { "uuid": "6518676c-9c6d-45ae-8109-a30158aa773a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "144b1674-2518-4ce9-90a7-0a3324e44831", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9cea2922-dd89-4001-8bf3-6663d512b5d6", "documentation": "", "method": "get", "endpoint": "v1/customers/:customer/discount", "responses": [ { "uuid": "c270baec-d898-47dd-86d8-f2b18c321bf6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "68dece0f-bf38-4627-84be-a0c2d39491f0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aac3fde5-867e-4a59-a494-a149cacac25f", "documentation": "

List sources for a specified customer.

", "method": "get", "endpoint": "v1/customers/:customer/sources", "responses": [ { "uuid": "fd84f304-6bcf-4a6d-9f80-e9918d457092", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f51a532b-6f3a-4220-bf53-e72755378ab2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8f4cf246-956f-4374-849c-be881e391b00", "documentation": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "method": "post", "endpoint": "v1/customers/:customer/sources", "responses": [ { "uuid": "8de09afd-a6e3-4780-af8e-1ab7770c9da0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ec88bb73-41fa-41a8-9f26-100f6049e954", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "207e99e0-9736-43ee-8371-e2b7e8fdaf31", "documentation": "

Delete a specified source for a given customer.

", "method": "delete", "endpoint": "v1/customers/:customer/sources/:id", "responses": [ { "uuid": "f94e8c72-274e-41f3-a4ad-7dc1d56a1f01", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ecd67909-0497-4b05-80cf-c8f10fed2768", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8466048a-c440-4a32-96a5-549ba3e40cef", "documentation": "

Retrieve a specified source for a given customer.

", "method": "get", "endpoint": "v1/customers/:customer/sources/:id", "responses": [ { "uuid": "d0d0c3e8-a1a6-4acd-8f51-604e57f210d2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0d389dad-5210-44f6-a45d-824b8f35b411", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5db59a5b-d851-4f54-9938-2256e2c1c972", "documentation": "

Update a specified source for a given customer.

", "method": "post", "endpoint": "v1/customers/:customer/sources/:id", "responses": [ { "uuid": "66e1778e-96eb-42a9-80d6-825dafa06dc6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "66dd4561-3998-46bc-abd7-97f8ffd1df42", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1e60bb8-5ae7-4b20-9a15-cbb02970a817", "documentation": "

Verify a specified bank account for a given customer.

", "method": "post", "endpoint": "v1/customers/:customer/sources/:id/verify", "responses": [ { "uuid": "7596bd7c-5c9f-4348-9e04-276a5eff932a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a2639e3c-1a39-45af-9985-335c0ba73286", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c541e34d-7c13-40ec-9a58-348c90310796", "documentation": "

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

", "method": "get", "endpoint": "v1/customers/:customer/subscriptions", "responses": [ { "uuid": "6eedb1e7-a88c-45ee-bc4c-4f9e206bb8a6", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c80b9a81-a899-459e-a67d-bbc68ebe4324", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "54d8974a-5598-4214-9b8c-188c37f23377", "documentation": "

Creates a new subscription on an existing customer.

", "method": "post", "endpoint": "v1/customers/:customer/subscriptions", "responses": [ { "uuid": "cbbf8e09-192d-4bca-8422-947967f2755f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ade4f650-1e91-4560-b927-3a712bef3aac", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a5080640-d227-4c52-b1cf-02a605200abd", "documentation": "

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

", "method": "delete", "endpoint": "v1/customers/:customer/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "aca17a50-b581-4697-97a1-fd79c138df47", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "35409171-e8f8-4c2d-ae58-89e0091efdc1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "36c1842f-c5cd-4776-b421-20e406888501", "documentation": "

Retrieves the subscription with the given ID.

", "method": "get", "endpoint": "v1/customers/:customer/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "32621c14-99af-4bda-a5b7-b1d58f832dcb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "48819b93-81a7-4713-811c-ce581651bc21", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a357a075-ae0f-4230-ad7e-887e677c3e7a", "documentation": "

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

", "method": "post", "endpoint": "v1/customers/:customer/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "534bc5be-ebcc-4f47-9f84-78fec7f8d558", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "134ce295-3f60-4197-9c1c-b6868c044814", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f0ee6a1b-8ed2-413c-99aa-26d872d9476d", "documentation": "

Removes the currently applied discount on a customer.

", "method": "delete", "endpoint": "v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "responses": [ { "uuid": "a021743e-0c28-45aa-a1a1-a20a1b97d6ce", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c031e02a-facb-45d3-a2d0-97ea0fa1faf2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18c89f98-ec9c-433a-b4c2-39a217a7778f", "documentation": "", "method": "get", "endpoint": "v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "responses": [ { "uuid": "74c5765b-df98-48f6-ac06-861c187d4edb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "8a215d23-cbee-43cb-8524-b6c0191e6ab6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18747123-fa6c-4ba3-acff-5c30c3d96851", "documentation": "

Returns a list of tax IDs for a customer.

", "method": "get", "endpoint": "v1/customers/:customer/tax_ids", "responses": [ { "uuid": "ff9047b7-82aa-4985-82da-155e4e5be3f8", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2bc4523f-a8eb-42d7-88ab-9efcdd03541a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "794bddd8-188e-4c5d-a42e-f55345bf187b", "documentation": "

Creates a new TaxID object for a customer.

", "method": "post", "endpoint": "v1/customers/:customer/tax_ids", "responses": [ { "uuid": "a882e3f6-736a-4b39-92a4-769d891fd0f6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d3ba5763-0656-46b2-8faa-2ad0ceed5ea4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f775f28-9c30-4bcd-a620-952adf7d5597", "documentation": "

Deletes an existing TaxID object.

", "method": "delete", "endpoint": "v1/customers/:customer/tax_ids/:id", "responses": [ { "uuid": "7a60e806-d2b8-432f-afc4-46f775a69819", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'tax_id')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "619e7ca4-1120-49bb-9e91-b75d647d4ffa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5297c84c-e1be-4c65-810f-53ee35efe309", "documentation": "

Retrieves the TaxID object with the given identifier.

", "method": "get", "endpoint": "v1/customers/:customer/tax_ids/:id", "responses": [ { "uuid": "4f2b7347-3705-4ef6-8edc-6029292a16f8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5972d294-d2db-4bb2-be67-39436125ebac", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7edcd29-1c24-43f3-b0e2-5e55dcad946f", "documentation": "

Returns a list of your disputes.

", "method": "get", "endpoint": "v1/disputes", "responses": [ { "uuid": "1425f07f-f932-4516-a391-6449f179a060", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f940ed0b-6c94-474a-8f44-3cbad5ea49fb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "418cc352-d731-4e67-b5a0-b9f132bb8e54", "documentation": "

Retrieves the dispute with the given ID.

", "method": "get", "endpoint": "v1/disputes/:dispute", "responses": [ { "uuid": "9b4ca784-88a9-4882-bd61-d95cf3eec415", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b0272157-44db-4ba6-b9b4-27801ae86285", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "773cf151-5065-40ad-aa14-9a82f631b250", "documentation": "

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

\n\n

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

", "method": "post", "endpoint": "v1/disputes/:dispute", "responses": [ { "uuid": "86356144-f587-4625-b32a-daa3b2ff62b5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "21ebea64-71bf-4299-bfc9-0b42ba7c964d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b802aaa2-ee05-405c-975c-b2299dbc712f", "documentation": "

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

\n\n

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

", "method": "post", "endpoint": "v1/disputes/:dispute/close", "responses": [ { "uuid": "9cdfa6d3-7ed8-4a40-bd40-99e788f6e0bd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c665a83e-3dca-4e00-92a4-bfb9a0c6a940", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8d6ca44b-ac83-42a1-a668-912cbfdd183b", "documentation": "

Creates a short-lived API key for a given resource.

", "method": "post", "endpoint": "v1/ephemeral_keys", "responses": [ { "uuid": "f2a164bf-24e6-46e8-8e37-8d68a6888b0c", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"expires\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'ephemeral_key')}}\",\n \"secret\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d8012217-84d0-49b3-b3eb-51c2f778b96b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4897d39-83aa-4522-9828-cc89b9544ddd", "documentation": "

Invalidates a short-lived API key for a given resource.

", "method": "delete", "endpoint": "v1/ephemeral_keys/:key", "responses": [ { "uuid": "64cf8f7f-784d-48a3-b277-77df0f39aab3", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"expires\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'ephemeral_key')}}\",\n \"secret\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "80070df0-1a59-489e-b9dc-dd81b844afe5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9806f1a0-c7ca-494e-b8ea-a1da8ae6256c", "documentation": "

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

", "method": "get", "endpoint": "v1/events", "responses": [ { "uuid": "6cd07113-d69e-45a6-a26c-53f8bda934e0", "body": "{\n \"data\": [\n {\n \"account\": \"\",\n \"api_version\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"data\": {\n \"object\": {},\n \"previous_attributes\": {}\n },\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'event')}}\",\n \"pending_webhooks\": {{faker 'number.int' max=99999}},\n \"request\": {\n \"id\": \"\",\n \"idempotency_key\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "34302ab7-9a70-4adb-b499-b94de956e987", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "339ce62a-2095-40f8-ae8d-adb00dcc1d33", "documentation": "

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

", "method": "get", "endpoint": "v1/events/:id", "responses": [ { "uuid": "d2bf557c-1bb7-4cdd-b657-4213b470b2a4", "body": "{\n \"account\": \"\",\n \"api_version\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"data\": {\n \"object\": {},\n \"previous_attributes\": {}\n },\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'event')}}\",\n \"pending_webhooks\": {{faker 'number.int' max=99999}},\n \"request\": {\n \"id\": \"\",\n \"idempotency_key\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e38827fd-d5c5-4090-b5e3-f32254434b66", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ffc4e49-9f5a-471b-beb9-94e4e4f4cbe5", "documentation": "

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

", "method": "get", "endpoint": "v1/exchange_rates", "responses": [ { "uuid": "bad5888d-4a02-4186-a28f-252003e163e6", "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'exchange_rate')}}\",\n \"rates\": {}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "91678ee2-270b-4144-bb1d-ea6701a52c8c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0ebe1692-a110-4402-82f9-7d586683fdc7", "documentation": "

Retrieves the exchange rates from the given currency to every supported currency.

", "method": "get", "endpoint": "v1/exchange_rates/:rate_id", "responses": [ { "uuid": "3a87c654-a7e4-4455-82c0-f20b1f8a7673", "body": "{\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'exchange_rate')}}\",\n \"rates\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3c1c0fbf-31d3-44ab-97b9-d909b7c404c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7824c62f-234b-49a2-be38-5b5726e20215", "documentation": "

Returns a list of file links.

", "method": "get", "endpoint": "v1/file_links", "responses": [ { "uuid": "b50de1cf-0bd9-40cd-8cfa-f3af1d6e39db", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "119099a4-8397-4af9-8c75-c02b6b306e22", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d654296-5f8e-46d1-9417-1b75e33652c2", "documentation": "

Creates a new file link object.

", "method": "post", "endpoint": "v1/file_links", "responses": [ { "uuid": "494317af-62cb-4a78-907f-4150ae1cf685", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "609775b8-271d-4a97-9650-0a292a8dbb27", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de380902-6df5-4d0a-bf9e-089f018a9a50", "documentation": "

Retrieves the file link with the given ID.

", "method": "get", "endpoint": "v1/file_links/:link", "responses": [ { "uuid": "22b4132b-06fb-4480-ad19-1b140805d751", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5fbc0846-a657-4af1-9d33-e5a9f7956bb8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f3dbad27-aa70-4991-bcf4-7df973cb7501", "documentation": "

Updates an existing file link object. Expired links can no longer be updated.

", "method": "post", "endpoint": "v1/file_links/:link", "responses": [ { "uuid": "f48733d2-6aa9-4780-900a-a605f7ff6de4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ca26d307-a80c-4106-8281-a05320364d39", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aaf1ea06-ba23-45b5-832c-d73e1343ab35", "documentation": "

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

", "method": "get", "endpoint": "v1/files", "responses": [ { "uuid": "76c9f504-7bea-4617-8787-0993e302aebd", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ed446393-3f6a-49b9-856f-caf94dbdfe6e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "92796b2e-0824-47be-a86b-087a5be1d48d", "documentation": "

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

", "method": "post", "endpoint": "v1/files", "responses": [ { "uuid": "91afca39-2a93-4951-8c26-7b295f164d42", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9be32f21-794a-4d98-8b43-873fd20672ab", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f8e9872-ce84-43f4-ab22-09fc929caa31", "documentation": "

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

", "method": "get", "endpoint": "v1/files/:file", "responses": [ { "uuid": "00b8ef36-dcda-4acc-99b3-1fe8f37033a6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a9f8227f-c574-4cb2-ba60-41aa9fe51251", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "032a7eec-eac1-46b3-9377-b4b8b81f0eab", "documentation": "

List all verification reports.

", "method": "get", "endpoint": "v1/identity/verification_reports", "responses": [ { "uuid": "415c450c-3672-464b-8118-541b6fa2f392", "body": "{\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"document\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"error\": {\n \"code\": \"{{oneOf (array 'document_expired' 'document_type_not_supported' 'document_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"expiration_date\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"files\": [\n \"\"\n ],\n \"first_name\": \"\",\n \"issued_date\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"issuing_country\": \"\",\n \"last_name\": \"\",\n \"number\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\",\n \"type\": \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n },\n \"id\": \"\",\n \"id_number\": {\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"error\": {\n \"code\": \"{{oneOf (array 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'identity.verification_report')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"selfie\": {\n \"document\": \"\",\n \"error\": {\n \"code\": \"{{oneOf (array 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"selfie\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\"\n },\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"verification_session\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "58ef4933-8223-4f2f-9e46-38ef87240142", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cc112b7c-bb72-40e6-acf9-ee48cb2d69c2", "documentation": "

Retrieves an existing VerificationReport

", "method": "get", "endpoint": "v1/identity/verification_reports/:report", "responses": [ { "uuid": "c9cdd400-260d-42cf-8c34-e8c9a8ced8f4", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"document\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"error\": {\n \"code\": \"{{oneOf (array 'document_expired' 'document_type_not_supported' 'document_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"expiration_date\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"files\": [\n \"\"\n ],\n \"first_name\": \"\",\n \"issued_date\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"issuing_country\": \"\",\n \"last_name\": \"\",\n \"number\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\",\n \"type\": \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n },\n \"id\": \"\",\n \"id_number\": {\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"error\": {\n \"code\": \"{{oneOf (array 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'identity.verification_report')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"selfie\": {\n \"document\": \"\",\n \"error\": {\n \"code\": \"{{oneOf (array 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other')}}\",\n \"reason\": \"\"\n },\n \"selfie\": \"\",\n \"status\": \"{{oneOf (array 'unverified' 'verified')}}\"\n },\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"verification_session\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6463a67d-2e9e-443e-8010-ee4977ec9a30", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0e9fa498-c695-4101-9056-a45c5bf0cc2b", "documentation": "

Returns a list of VerificationSessions

", "method": "get", "endpoint": "v1/identity/verification_sessions", "responses": [ { "uuid": "98182f03-4ede-4e67-93a1-1e8b09b07954", "body": "{\n \"data\": [\n {\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e75ca29d-fca1-41b1-8029-4fc52d24da04", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "048fc044-fcf4-4c03-8140-05d0df3f4964", "documentation": "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents.

", "method": "post", "endpoint": "v1/identity/verification_sessions", "responses": [ { "uuid": "bde81786-64e6-40cb-80db-542899dae5ca", "body": "{\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "428b63cb-e319-47a9-855e-a553c7baf283", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "25430189-e4e2-4011-b182-f9fc023ed8be", "documentation": "

Retrieves the details of a VerificationSession that was previously created.

\n\n

When the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.

", "method": "get", "endpoint": "v1/identity/verification_sessions/:session", "responses": [ { "uuid": "f8522087-b475-4b6f-8ba8-3e1b26a37d65", "body": "{\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6ebbaa70-53f3-4497-8787-4e69bf7a638f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1b498f0-c361-4138-ae7e-0433fc87e3ef", "documentation": "

Updates a VerificationSession object.

\n\n

When the session status is requires_input, you can use this method to update the\nverification check and options.

", "method": "post", "endpoint": "v1/identity/verification_sessions/:session", "responses": [ { "uuid": "6f33d132-91d9-4e77-a964-c32ba472baa1", "body": "{\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0bfe44b2-2c81-4a88-bc9e-a9b3c8ef9549", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48e5dfe7-4f5c-4232-a7ea-c46b5aa1cbf2", "documentation": "

A VerificationSession object can be canceled when it is in requires_input status.

\n\n

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

", "method": "post", "endpoint": "v1/identity/verification_sessions/:session/cancel", "responses": [ { "uuid": "0356b577-60ab-47ff-91bf-192423be420b", "body": "{\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9ece5876-6cf4-4509-bcc9-c9452c022680", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4d8a1482-7b48-4083-b20d-d23aff4753fa", "documentation": "

Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.

\n\n

A VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.

\n\n

The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.

\n\n

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.

\n\n

Learn more.

", "method": "post", "endpoint": "v1/identity/verification_sessions/:session/redact", "responses": [ { "uuid": "47789370-c577-4bad-b1c7-3c625df880c7", "body": "{\n \"client_secret\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"last_error\": {\n \"code\": \"{{oneOf (array 'abandoned' 'consent_declined' 'country_not_supported' 'device_not_supported' 'document_expired' 'document_type_not_supported' 'document_unverified_other' 'id_number_insufficient_document_data' 'id_number_mismatch' 'id_number_unverified_other' 'selfie_document_missing_photo' 'selfie_face_mismatch' 'selfie_manipulated' 'selfie_unverified_other' 'under_supported_age')}}\",\n \"reason\": \"\"\n },\n \"last_verification_report\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'identity.verification_session')}}\",\n \"options\": {\n \"document\": {\n \"allowed_types\": [\n \"{{oneOf (array 'driving_license' 'id_card' 'passport')}}\"\n ],\n \"require_id_number\": {{faker 'datatype.boolean'}},\n \"require_live_capture\": {{faker 'datatype.boolean'}},\n \"require_matching_selfie\": {{faker 'datatype.boolean'}}\n },\n \"id_number\": {}\n },\n \"redaction\": {\n \"status\": \"{{oneOf (array 'processing' 'redacted')}}\"\n },\n \"status\": \"{{oneOf (array 'canceled' 'processing' 'requires_input' 'verified')}}\",\n \"type\": \"{{oneOf (array 'document' 'id_number')}}\",\n \"url\": \"\",\n \"verified_outputs\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"dob\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"first_name\": \"\",\n \"id_number\": \"\",\n \"id_number_type\": \"{{oneOf (array 'br_cpf' 'sg_nric' 'us_ssn')}}\",\n \"last_name\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "54a5456d-fe60-40bc-9e9d-13c686ca4943", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "39ad2632-c167-4c56-a48b-6ac5b4fa18bd", "documentation": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", "method": "get", "endpoint": "v1/invoiceitems", "responses": [ { "uuid": "9ef76e6c-07de-4670-b376-5fd5bdc2cbf5", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d7ce1b99-80ba-4480-872b-7dd2a0cd16bb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1184f0b1-254f-4d05-8f8b-b16ba4bccd3f", "documentation": "

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

", "method": "post", "endpoint": "v1/invoiceitems", "responses": [ { "uuid": "608892bf-0ded-451a-a709-e29565991b88", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fe81b370-eb35-4cbf-b9e4-a0497ec5ecf6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2285aa4-9a26-469b-a187-f0e0cdd12871", "documentation": "

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

", "method": "delete", "endpoint": "v1/invoiceitems/:invoiceitem", "responses": [ { "uuid": "75b428e6-b99d-4dec-9103-76a289f581b0", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'invoiceitem')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bba056ef-ecf6-4c4e-a990-d548fcbd8b8b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cb306c89-af4b-428f-bf77-69a77e10369e", "documentation": "

Retrieves the invoice item with the given ID.

", "method": "get", "endpoint": "v1/invoiceitems/:invoiceitem", "responses": [ { "uuid": "b17f2a0c-700f-420e-bc29-8de4f07e7a82", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "800e4667-d1d3-41b2-b490-a4560969de99", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "036bd77b-e80f-43f3-a891-cff4719794c1", "documentation": "

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

", "method": "post", "endpoint": "v1/invoiceitems/:invoiceitem", "responses": [ { "uuid": "635ec85c-9f10-4872-9a2d-cd5697d96190", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e9bfa6e3-c68e-41e1-8cbb-17e38268d448", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35f99483-db4b-4aba-a3e4-1b0e1e078cea", "documentation": "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

", "method": "get", "endpoint": "v1/invoices", "responses": [ { "uuid": "c6547e51-bdb3-47cf-a27f-958bdc47601b", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4d804a51-971d-4c79-95d8-876a43fc2805", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9eefa5b-a90a-4355-abbf-396f4d1cfb4f", "documentation": "

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

", "method": "post", "endpoint": "v1/invoices", "responses": [ { "uuid": "9263aa55-e00f-45f2-bb8c-837166727b74", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f55ee406-7ad5-4717-bad9-640ab8d43a20", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e84c7df-56f9-4e8d-a9a7-80488ec03127", "documentation": "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

", "method": "get", "endpoint": "v1/invoices/upcoming", "responses": [ { "uuid": "a433d755-0eb9-4e85-b4ff-2093cd8e420b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "109f33db-e32d-461c-b5dc-714910779d5f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a1f6f94d-1ef1-42c0-b007-35ff1c23f456", "documentation": "

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/invoices/upcoming/lines", "responses": [ { "uuid": "3dd2c80a-4754-4080-b266-ee13d39b5676", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a6f61f93-70a8-4133-beb5-002d86f8ebba", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c336496-c0e8-42e9-942e-2351202f5056", "documentation": "

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

", "method": "delete", "endpoint": "v1/invoices/:invoice", "responses": [ { "uuid": "2f2068fd-9201-47c2-91dc-e91c184fe5d4", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'invoice')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2d43a244-1257-44c0-9ab2-f341e3dfa813", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ec5f1414-0308-4d4e-a561-3e657dc0990e", "documentation": "

Retrieves the invoice with the given ID.

", "method": "get", "endpoint": "v1/invoices/:invoice", "responses": [ { "uuid": "4c2527f0-6120-418c-a15a-941736888308", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f47ab911-fee6-4e54-aff0-b04d486c8c48", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5414c33a-5ef6-4145-b023-bd57ace8f3d4", "documentation": "

Draft invoices are fully editable. Once an invoice is finalized,\nmonetary values, as well as collection_method, become uneditable.

\n\n

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.

", "method": "post", "endpoint": "v1/invoices/:invoice", "responses": [ { "uuid": "67e7ca69-c742-4342-bad4-1e17abec6bc6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ad111cf7-0105-4462-80e6-3197fae14a64", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8b0d538-e0aa-48c9-a058-d3e5e29cbc57", "documentation": "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

", "method": "post", "endpoint": "v1/invoices/:invoice/finalize", "responses": [ { "uuid": "09e84a67-9f1b-472a-81e9-a74b571ed457", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1321c838-b4a6-496e-b50f-33abd3759eca", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1a9c484-9d3f-4551-8470-f0bd6f0f8776", "documentation": "

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/invoices/:invoice/lines", "responses": [ { "uuid": "27b3d151-3ee5-4f6d-875e-f3a1e2b8257e", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "82e1d212-bad2-4f44-b324-28d6bdac8105", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "36da4ced-764e-4ef3-801d-7af5f28f3d4f", "documentation": "

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

", "method": "post", "endpoint": "v1/invoices/:invoice/mark_uncollectible", "responses": [ { "uuid": "fac3f8ef-0a34-46bd-af06-5ca7b37e8e3a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9f3d9ead-1e5b-45ac-82fa-642cd45d9a66", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b233cde-2c47-443a-aade-3df1853f434d", "documentation": "

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

", "method": "post", "endpoint": "v1/invoices/:invoice/pay", "responses": [ { "uuid": "0b2a8929-2fc3-4d42-a66b-4dd2ff3b5df8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b04e2c99-c218-4be4-b2c5-3d06f4ad2969", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8f24da40-a27b-4728-ae34-4747b2f90349", "documentation": "

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

\n\n

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

", "method": "post", "endpoint": "v1/invoices/:invoice/send", "responses": [ { "uuid": "0feba94d-d45c-4840-b0f1-de9e57467d96", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f36e5f11-12be-4c77-9ea5-bd7fe00a85cc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "077d61d3-c361-4a52-93b8-8ea86d4c0331", "documentation": "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

", "method": "post", "endpoint": "v1/invoices/:invoice/void", "responses": [ { "uuid": "f25568c8-7580-4812-b7c6-69f28ee5feef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a12c8168-cc47-47da-b46c-3d4f203061f9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cc7791af-ecee-4a6f-8f6f-3fe79fbb0fd6", "documentation": "

Returns a list of issuer fraud records.

", "method": "get", "endpoint": "v1/issuer_fraud_records", "responses": [ { "uuid": "f56d19ce-eaa3-4187-af96-ad6c1f2b9bac", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5e23554e-9964-45a8-949f-92707a184279", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c82b285a-d391-4bf7-bf1d-f8415dbdea9d", "documentation": "

Retrieves the details of an issuer fraud record that has previously been created.

\n\n

Please refer to the issuer fraud record object reference for more details.

", "method": "get", "endpoint": "v1/issuer_fraud_records/:issuer_fraud_record", "responses": [ { "uuid": "bfe13996-e314-4ab2-8a57-a5be9e958807", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "02662622-202c-4235-bea3-7a390d5d389a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f6f5c3d-96c1-4384-9454-380264466796", "documentation": "

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/authorizations", "responses": [ { "uuid": "ed442e05-d3c1-418b-86b3-41dce6a2390c", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ab23b7e9-772f-498d-8d32-f8fd9767c1af", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc64b271-23be-46ba-8cdd-153a662b0557", "documentation": "

Retrieves an Issuing Authorization object.

", "method": "get", "endpoint": "v1/issuing/authorizations/:authorization", "responses": [ { "uuid": "e041d9bf-98c4-459a-ab65-9c5bbe3b3b7e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7b0588c2-50ae-4877-a84f-4303cac43739", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "680d0e5a-afe6-4fc4-a93d-77b328f9be88", "documentation": "

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/issuing/authorizations/:authorization", "responses": [ { "uuid": "c5f00541-4df1-467b-9dc2-727454f6f191", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "21665b60-7817-4dd5-961c-1bd3677a4610", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7018d6c7-2549-4054-bc48-94b32f7bbec3", "documentation": "

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

", "method": "post", "endpoint": "v1/issuing/authorizations/:authorization/approve", "responses": [ { "uuid": "cb180445-4e8d-4560-a412-a464a186b485", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "29bbfdd6-38cd-460e-8e4e-77f41ff18b30", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "443773f8-a1c6-4171-8e7b-f8f955fee1e4", "documentation": "

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

", "method": "post", "endpoint": "v1/issuing/authorizations/:authorization/decline", "responses": [ { "uuid": "6b423f94-b85b-4dc6-9307-32c0d087de77", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ca454821-9a98-4557-9b19-a90e8ef1fa10", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f07a3ba6-9872-4f40-b178-514c0b7a690e", "documentation": "

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/cardholders", "responses": [ { "uuid": "5e7b81b7-93dd-47b9-ad4a-87611e2142ec", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5541b5e8-dd82-4afe-a8ff-18465d1e8f4a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d8aba35d-f57d-49b6-a797-2b15d70be5bf", "documentation": "

Creates a new Issuing Cardholder object that can be issued cards.

", "method": "post", "endpoint": "v1/issuing/cardholders", "responses": [ { "uuid": "0dbd68dc-0610-4627-bc7a-5b8ee520dc04", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f462d2d0-7940-458d-9eb0-5cf0c3827497", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4947b145-c42a-42c3-bf94-1b220023b364", "documentation": "

Retrieves an Issuing Cardholder object.

", "method": "get", "endpoint": "v1/issuing/cardholders/:cardholder", "responses": [ { "uuid": "292135b6-3d16-4211-b37f-ac1afc0df21a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5190c46d-988b-4165-904a-41a51b8ad8a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9094624a-de30-4144-9ffb-d6a6d2372478", "documentation": "

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/issuing/cardholders/:cardholder", "responses": [ { "uuid": "d4e12dc2-b486-4251-944e-419f9655190a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "899d0787-a501-4585-a9c5-2612cd5d868f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b236513-df2a-4cc3-ad44-321f2cf2354d", "documentation": "

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/cards", "responses": [ { "uuid": "20b5002b-744e-4f1f-a825-31dea7960c0d", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "450c28f4-d6ba-4475-8e3e-fbc41137260d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43a2051f-ad77-4788-9107-28f25c12d53c", "documentation": "

Creates an Issuing Card object.

", "method": "post", "endpoint": "v1/issuing/cards", "responses": [ { "uuid": "5f979b46-5395-4320-b292-dd7868876042", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4bfadd5a-e55a-4b9c-b573-aee09658475c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa4a47e9-9013-4d97-b2c5-b2770765e7f5", "documentation": "

Retrieves an Issuing Card object.

", "method": "get", "endpoint": "v1/issuing/cards/:card", "responses": [ { "uuid": "8f0aa620-cbdc-4a81-b421-baa468c6da53", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9a63cd6e-95b7-4fc2-b16f-fd8d6b90e155", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "51013968-5cda-4bf8-bace-ee0cb2001ba1", "documentation": "

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/issuing/cards/:card", "responses": [ { "uuid": "43ac2d7c-b6fa-47b8-9146-762da8ff6b8c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "737204e8-cde7-4938-a288-41950ef41a62", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9937e0e2-0172-4f1b-af41-1eabe549930a", "documentation": "

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/disputes", "responses": [ { "uuid": "58f22023-88c4-46c5-9b45-3126cb4fd6f0", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c6c25477-38b5-41f8-af5d-4b59af8bd4fa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db49f85d-8ea3-4ce8-a33e-00a027a1f2e5", "documentation": "

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

", "method": "post", "endpoint": "v1/issuing/disputes", "responses": [ { "uuid": "e037af46-500d-4ad7-a72e-8dcd3dc2abcb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "043de783-6da4-49e9-bf97-8f2d7754d715", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c1cddf1e-a78a-4a1e-8ac4-2fa5678fc5e6", "documentation": "

Retrieves an Issuing Dispute object.

", "method": "get", "endpoint": "v1/issuing/disputes/:dispute", "responses": [ { "uuid": "55642874-0599-4754-b418-cc448e237caf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "77aefc29-2cb9-47ff-bc2d-8d43d3806533", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b41365e-7005-416a-a832-b1460f78a938", "documentation": "

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

", "method": "post", "endpoint": "v1/issuing/disputes/:dispute", "responses": [ { "uuid": "540d9293-cd4b-4eb4-ab9c-001d898c9c9a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "338e800a-a8cb-4e3e-911b-f494098f4035", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ad34f67-dd14-4c79-8eb1-ac934031f4e8", "documentation": "

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

", "method": "post", "endpoint": "v1/issuing/disputes/:dispute/submit", "responses": [ { "uuid": "0dd693f3-61d6-4681-a987-5f959c7b0351", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "eb3da968-c941-4f8d-a82b-be08ba32e2a7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80e59027-96fc-4c7e-a218-c6a698d3b675", "documentation": "

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/settlements", "responses": [ { "uuid": "a5bcb1f2-310b-4f8e-9440-83ac495df47f", "body": "{\n \"data\": [\n {\n \"bin\": \"\",\n \"clearing_date\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interchange_fees\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"net_total\": {{faker 'number.int' max=99999}},\n \"network\": \"{{oneOf (array 'visa')}}\",\n \"network_fees\": {{faker 'number.int' max=99999}},\n \"network_settlement_identifier\": \"\",\n \"object\": \"{{oneOf (array 'issuing.settlement')}}\",\n \"settlement_service\": \"\",\n \"transaction_count\": {{faker 'number.int' max=99999}},\n \"transaction_volume\": {{faker 'number.int' max=99999}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "19867cf8-a040-46af-a273-89a1c70511d4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "341d231f-8960-41ca-ac6a-aafcac3aa699", "documentation": "

Retrieves an Issuing Settlement object.

", "method": "get", "endpoint": "v1/issuing/settlements/:settlement", "responses": [ { "uuid": "c00e3fd8-6f1d-4b11-aee3-72e777ecc6b7", "body": "{\n \"bin\": \"\",\n \"clearing_date\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interchange_fees\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"net_total\": {{faker 'number.int' max=99999}},\n \"network\": \"{{oneOf (array 'visa')}}\",\n \"network_fees\": {{faker 'number.int' max=99999}},\n \"network_settlement_identifier\": \"\",\n \"object\": \"{{oneOf (array 'issuing.settlement')}}\",\n \"settlement_service\": \"\",\n \"transaction_count\": {{faker 'number.int' max=99999}},\n \"transaction_volume\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9fe32e6b-ba47-4384-8f96-8160a36cda53", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de743f7e-073d-45b5-9d51-e66a488de374", "documentation": "

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/issuing/settlements/:settlement", "responses": [ { "uuid": "13a75f8c-064e-4f20-ac31-ab0d731c6bc5", "body": "{\n \"bin\": \"\",\n \"clearing_date\": {{faker 'number.int' max=99999}},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interchange_fees\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"net_total\": {{faker 'number.int' max=99999}},\n \"network\": \"{{oneOf (array 'visa')}}\",\n \"network_fees\": {{faker 'number.int' max=99999}},\n \"network_settlement_identifier\": \"\",\n \"object\": \"{{oneOf (array 'issuing.settlement')}}\",\n \"settlement_service\": \"\",\n \"transaction_count\": {{faker 'number.int' max=99999}},\n \"transaction_volume\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3ccf98c6-c461-48ec-89f1-4bc0eccb23e7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d06a75c3-9c1a-488e-87e0-1413d00630e0", "documentation": "

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/issuing/transactions", "responses": [ { "uuid": "d8586088-0547-46e2-a59a-df175a722e64", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4f183ee7-766f-4ed4-9962-35cb3df8d1fe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c296ef0e-5cd4-4a17-b144-2b0fe8823412", "documentation": "

Retrieves an Issuing Transaction object.

", "method": "get", "endpoint": "v1/issuing/transactions/:transaction", "responses": [ { "uuid": "1cf6721d-b635-438d-a7a3-6d2aaccc33b6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d8a20cb7-c91f-4add-b1d1-b3af74a83bf4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "274ec179-5bfc-4705-9b99-aabc9b728f8a", "documentation": "

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/issuing/transactions/:transaction", "responses": [ { "uuid": "a915ae32-bf36-49c8-ad53-a1c9a3785487", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6cc6ec99-3cbf-4e40-b9bb-935e0e4db3e0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ed1d5ca-1fd7-4d3d-b0f9-24b38a6f8ab6", "documentation": "

Retrieves a Mandate object.

", "method": "get", "endpoint": "v1/mandates/:mandate", "responses": [ { "uuid": "9fc9b091-e4f4-47c0-a9c7-eabe7e56cf2e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9087c10e-a863-4c12-a091-a17e055df677", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "31b39e9a-c304-4963-9334-d06adce9b9ca", "documentation": "

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

", "method": "get", "endpoint": "v1/order_returns", "responses": [ { "uuid": "144e787a-8da2-4d0a-ba4e-282591127ff1", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "777545d3-7ab9-45d7-825b-ba784eca733d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dd4dba4d-01cc-4f55-8e8c-0dad974867d7", "documentation": "

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

", "method": "get", "endpoint": "v1/order_returns/:id", "responses": [ { "uuid": "488fca06-e2ee-4096-8223-46a473895d8e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "acea4cfc-780c-47f2-905b-24147d56194c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10a90d76-7dab-411f-bc99-4a5c9c6dd2af", "documentation": "

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

", "method": "get", "endpoint": "v1/orders", "responses": [ { "uuid": "abe25fca-ff74-4716-88de-1d0488445d9f", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "50ed91e2-9e03-4ca9-8a95-b757f8073f0d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63fc84ed-9ef6-41fb-8072-9a65894093ee", "documentation": "

Creates a new order object.

", "method": "post", "endpoint": "v1/orders", "responses": [ { "uuid": "e03cd0ad-fca7-4bf3-af0c-1ebf7950f09f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4ff183d5-db63-4e1d-90b3-13a8fe7266c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eb60922c-69cd-4a68-9cd8-c9d0e3d8bb4c", "documentation": "

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

", "method": "get", "endpoint": "v1/orders/:id", "responses": [ { "uuid": "8cf2e3db-3ff4-45ff-a51f-5c30f0d75325", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5e3d583a-db8a-4e57-bf20-5d9138ccd746", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac1fe2f3-4207-42cf-8557-ac9cdb89045a", "documentation": "

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/orders/:id", "responses": [ { "uuid": "75cbe6d5-ff98-48fc-a511-0af833dbbc75", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "92eba0e5-0efa-4907-9740-145428a6c008", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c1c97c95-585a-4516-a81b-d86003492186", "documentation": "

Pay an order by providing a source to create a payment.

", "method": "post", "endpoint": "v1/orders/:id/pay", "responses": [ { "uuid": "fdca7c46-14ee-4339-882b-4bb42c05ab22", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e53d701e-3621-4740-8328-a6cd9b15143c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9cb0298-470b-4079-a8af-48ecb4a23f5e", "documentation": "

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

", "method": "post", "endpoint": "v1/orders/:id/returns", "responses": [ { "uuid": "07ebccf7-04c4-4e87-89a0-1275d054dce4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "063d9e64-3b0f-423b-a7b7-379ca4f96dc9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d94dfcd3-8af2-4a5d-a4f3-8dd61338b3f5", "documentation": "

Returns a list of PaymentIntents.

", "method": "get", "endpoint": "v1/payment_intents", "responses": [ { "uuid": "c1fc2269-b4d7-4e1b-88dc-aaaa32da80dc", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "980b6c84-68f5-420a-8273-9324d6ce189c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "72497e8a-c33c-4ad5-8124-f9d9b2bd4e38", "documentation": "

Creates a PaymentIntent object.

\n\n

After the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. You can read more about the different payment flows\navailable via the Payment Intents API here.

\n\n

When confirm=true is used during creation, it is equivalent to creating\nand confirming the PaymentIntent in the same call. You may use any parameters\navailable in the confirm API when confirm=true\nis supplied.

", "method": "post", "endpoint": "v1/payment_intents", "responses": [ { "uuid": "fbe63baa-a593-4273-a406-e341eab73260", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5ff389ad-018d-4e3d-ac4f-7e0b46ad527c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ce04c995-0152-45b4-87cf-842b575ae622", "documentation": "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

\n\n

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

", "method": "get", "endpoint": "v1/payment_intents/:intent", "responses": [ { "uuid": "729ec1ad-0456-4ee8-9bba-25d595fc11ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3936b738-c587-4cdc-9e25-db5a08a9c491", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4725a046-c913-4df3-895e-38c9165fba1d", "documentation": "

Updates properties on a PaymentIntent object without confirming.

\n\n

Depending on which properties you update, you may need to confirm the\nPaymentIntent again. For example, updating the payment_method will\nalways require you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties via\nthe confirm API instead.

", "method": "post", "endpoint": "v1/payment_intents/:intent", "responses": [ { "uuid": "f8189203-43ff-48e9-8aca-4a3f116ee453", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5d0264ab-d936-4b14-a5cb-22b82b76e2ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ce14e15e-eff4-43b9-aa3d-bd94b8343870", "documentation": "

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, or requires_action.

\n\n

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

", "method": "post", "endpoint": "v1/payment_intents/:intent/cancel", "responses": [ { "uuid": "62f4279b-72eb-4eb8-afc6-0f6a7aa1f0df", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5a425686-99dd-4985-849e-ce3f2cef35f8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6899f14b-65bf-4802-9366-d0d0c4900287", "documentation": "

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

\n\n

Uncaptured PaymentIntents will be canceled exactly seven days after they are created.

\n\n

Learn more about separate authorization and capture.

", "method": "post", "endpoint": "v1/payment_intents/:intent/capture", "responses": [ { "uuid": "2d0eb03c-d890-49ef-87fd-d7234bb2e148", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c0a8fab2-81d7-41bc-829c-376fcb82740e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a8ee84cc-9f17-4912-ab16-5055260a970c", "documentation": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.

\n\n

If the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent will transition to the requires_payment_method status. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).

\n\n

If the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.

\n\n

If the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt. Read the expanded documentation\nto learn more about manual confirmation.

", "method": "post", "endpoint": "v1/payment_intents/:intent/confirm", "responses": [ { "uuid": "1f90c83d-a372-4d14-887d-f61375d19869", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a43d8912-eca8-4435-b381-b6ee3a7df3f1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3142fb57-da80-41ef-8c81-c753c73fca18", "documentation": "

Returns a list of PaymentMethods for a given Customer

", "method": "get", "endpoint": "v1/payment_methods", "responses": [ { "uuid": "d370c47c-65da-46ba-9d10-d2ebcbc6425e", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5234bc35-2c23-4d22-9584-4bc29f3c2e39", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "272a1be1-d289-4bce-9e75-c7b52cadc804", "documentation": "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

", "method": "post", "endpoint": "v1/payment_methods", "responses": [ { "uuid": "273c6434-641b-462a-8642-541df28228d3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "96608d92-517e-4e2e-9054-e217da9ba628", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0fd64cad-41bd-410d-bac3-045c1da89fec", "documentation": "

Retrieves a PaymentMethod object.

", "method": "get", "endpoint": "v1/payment_methods/:payment_method", "responses": [ { "uuid": "fa33054f-924f-4748-8ae0-b51c9476034d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7609fc91-9921-466d-b2e9-0b7fc83438da", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9fab37e3-8d2f-4180-a6a5-b7985696ba58", "documentation": "

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

", "method": "post", "endpoint": "v1/payment_methods/:payment_method", "responses": [ { "uuid": "9dadbcdf-d91f-46d3-b4a4-8f1cc6c161ea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4be589c3-3429-4cd9-8213-363ee090733e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "96ead1f2-8291-4706-9eae-13055d346b4f", "documentation": "

Attaches a PaymentMethod object to a Customer.

\n\n

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to ensure that the PaymentMethod can be used in a future payment. Using the\n/v1/payment_methods/:id/attach endpoint does not ensure that future payments can be made with the attached PaymentMethod.\nSee Optimizing cards for future payments for more information about setting up future payments.

\n\n

To use this PaymentMethod as the default for invoice or subscription payments,\nset invoice_settings.default_payment_method,\non the Customer to the PaymentMethod’s ID.

", "method": "post", "endpoint": "v1/payment_methods/:payment_method/attach", "responses": [ { "uuid": "8a422f70-81aa-43c1-ac3b-efcf86434f73", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a801d85d-83f7-4c1b-81a5-47c1b8bdcf10", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e3bb772d-118e-419c-b853-e8abc99e6853", "documentation": "

Detaches a PaymentMethod object from a Customer.

", "method": "post", "endpoint": "v1/payment_methods/:payment_method/detach", "responses": [ { "uuid": "450c748d-43f8-4150-bf4d-18c5562f7f18", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "84855ba7-2957-460e-802c-aebecbd66690", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "20cba284-30de-469d-bc55-aa1b8b2ec10b", "documentation": "

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

", "method": "get", "endpoint": "v1/payouts", "responses": [ { "uuid": "0848f3c3-6774-4001-9b45-78f8ae7f703e", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c26d65f9-b4f9-4b19-85f3-0273ca64a244", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21683dbf-d815-4444-b075-e705965c281e", "documentation": "

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

\n\n

If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

\n\n

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

", "method": "post", "endpoint": "v1/payouts", "responses": [ { "uuid": "f67b7351-cdf3-47dc-9a1e-e67dc386f7ae", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "aa0f7d0a-3092-4383-bcff-36b51e734a60", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "120dde12-1c99-4786-9a76-b551e339a1a0", "documentation": "

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

", "method": "get", "endpoint": "v1/payouts/:payout", "responses": [ { "uuid": "48ed1ac1-8f16-4e41-b743-4f821093feb8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "87412b9d-680d-4409-9cb2-42956140f946", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5027c751-d966-4416-bf57-98769c50b4f5", "documentation": "

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

", "method": "post", "endpoint": "v1/payouts/:payout", "responses": [ { "uuid": "e931f1e2-f99e-44f3-92d4-86f0859f5b44", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "214b3e29-c3fa-478f-9e74-f81430f39abc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "33c7b446-9222-4a2c-8e64-ea5e7cd16a15", "documentation": "

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

", "method": "post", "endpoint": "v1/payouts/:payout/cancel", "responses": [ { "uuid": "9051b619-3a2b-4010-82fb-1be919ff7afb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "93fe64d5-3d3a-4671-ba9d-9ee778d844c2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "109c6630-84f6-4a05-9db4-4036b2d70c3f", "documentation": "

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

\n\n

By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

", "method": "post", "endpoint": "v1/payouts/:payout/reverse", "responses": [ { "uuid": "36597c78-d095-4422-a608-e7763f4fb76c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0b30ec28-4a8a-42f0-85df-fc3f646e4288", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a90ca23c-f80f-4e73-af5e-052d82ac889b", "documentation": "

Returns a list of your plans.

", "method": "get", "endpoint": "v1/plans", "responses": [ { "uuid": "382482ad-bbc4-41a4-95b8-01ff0617d74e", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_decimal\": \"\",\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'plan')}}\",\n \"product\": \"\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_usage\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"trial_period_days\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "83b89223-55ec-44fa-b27c-b0d5747df595", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bcde1f16-fe84-4ab6-88df-cb1e59b35679", "documentation": "

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

", "method": "post", "endpoint": "v1/plans", "responses": [ { "uuid": "af8cdad0-b1cb-4b17-9314-9737da9e05c2", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_decimal\": \"\",\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'plan')}}\",\n \"product\": \"\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_usage\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"trial_period_days\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ec1258d8-e43a-405b-9efd-9b0d30324568", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a236a144-2eff-48af-9638-3479329d4806", "documentation": "

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

", "method": "delete", "endpoint": "v1/plans/:plan", "responses": [ { "uuid": "7fc5d433-1ff9-491f-bd49-b7e2cee9f437", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'plan')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "25100c41-2153-4ec0-b4c5-c006c0a05ff9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "95a83497-d2f4-42f4-abbc-ecfd4b9d9db2", "documentation": "

Retrieves the plan with the given ID.

", "method": "get", "endpoint": "v1/plans/:plan", "responses": [ { "uuid": "411d6e3e-0791-4d37-84d1-16c412040edc", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_decimal\": \"\",\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'plan')}}\",\n \"product\": \"\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_usage\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"trial_period_days\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d69ddc60-c7cc-411d-996a-3dd7b4cc4ff2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4848645f-c342-458d-a43e-c979891b92ae", "documentation": "

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

", "method": "post", "endpoint": "v1/plans/:plan", "responses": [ { "uuid": "8f7585ba-3ed9-4c4c-a46b-da8513a33ab4", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"amount\": {{faker 'number.int' max=99999}},\n \"amount_decimal\": \"\",\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'plan')}}\",\n \"product\": \"\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_usage\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"trial_period_days\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7ef97cdb-d875-4775-8a0f-b221707f847a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f975f8e4-89be-478d-aa08-4acf0f4a4da4", "documentation": "

Returns a list of your prices.

", "method": "get", "endpoint": "v1/prices", "responses": [ { "uuid": "b5aeca7e-3f66-403e-a42f-928afa291a97", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "32277bbe-4963-48ad-938a-e09bff2d5af4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "28f31d47-2b56-4eeb-b2e0-e0b9c655cfbb", "documentation": "

Creates a new price for an existing product. The price can be recurring or one-time.

", "method": "post", "endpoint": "v1/prices", "responses": [ { "uuid": "d5c49450-67a8-47dc-92c2-4f3df5e13186", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7b7f5cb1-ce73-4a29-94ff-a26efb1837a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6fc4bfc5-ca53-4b4a-b083-30e21877d395", "documentation": "

Retrieves the price with the given ID.

", "method": "get", "endpoint": "v1/prices/:price", "responses": [ { "uuid": "be9573b1-447e-4cef-9391-7c73b71db358", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0801653b-6d23-4354-969c-4da759840276", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b831ff1-1680-4fa8-a637-af47a00603b5", "documentation": "

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

", "method": "post", "endpoint": "v1/prices/:price", "responses": [ { "uuid": "ecdcc2b4-e01b-4e68-9acd-ab4e536ba2d5", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e84c07ab-e439-4b03-9bb5-614d78b30187", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14f3f171-51a1-4e5e-a5eb-86520536d642", "documentation": "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

", "method": "get", "endpoint": "v1/products", "responses": [ { "uuid": "a2aee71e-3b83-4cce-bba0-24d63ed5f8ca", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"id\": \"\",\n \"images\": [\n \"\"\n ],\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'product')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"shippable\": {{faker 'datatype.boolean'}},\n \"statement_descriptor\": \"\",\n \"tax_code\": \"\",\n \"unit_label\": \"\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"url\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "261f5193-083e-4262-8ad4-d9b89ed4b012", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6d3f66c-349c-45d6-8f8e-0b361347234e", "documentation": "

Creates a new product object.

", "method": "post", "endpoint": "v1/products", "responses": [ { "uuid": "6b5c3bbc-7ffb-481a-95b6-e8cae67c4e1d", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"id\": \"\",\n \"images\": [\n \"\"\n ],\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'product')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"shippable\": {{faker 'datatype.boolean'}},\n \"statement_descriptor\": \"\",\n \"tax_code\": \"\",\n \"unit_label\": \"\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ed51b961-6e50-49df-a43b-9a01202578c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dfd12e16-ba1b-4881-b5f7-5d8499b204f8", "documentation": "

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

", "method": "delete", "endpoint": "v1/products/:id", "responses": [ { "uuid": "5306ebe2-b559-4f97-8248-85c8519a444a", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'product')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9615b0b1-c37d-4536-bf9c-19897e94f7f6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9612d27-94c0-4b15-bb32-0b0e8c0a8f3b", "documentation": "

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

", "method": "get", "endpoint": "v1/products/:id", "responses": [ { "uuid": "ff49882b-530f-485a-b1fb-84a05c5a3e5f", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"id\": \"\",\n \"images\": [\n \"\"\n ],\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'product')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"shippable\": {{faker 'datatype.boolean'}},\n \"statement_descriptor\": \"\",\n \"tax_code\": \"\",\n \"unit_label\": \"\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "89d286f6-8f8a-4160-ab4d-7e613459eccc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7299608a-5712-4fa3-bd89-6f85ac98c5b4", "documentation": "

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/products/:id", "responses": [ { "uuid": "c8824375-db84-48a9-a950-1edc8a30ddbb", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"id\": \"\",\n \"images\": [\n \"\"\n ],\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'product')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"shippable\": {{faker 'datatype.boolean'}},\n \"statement_descriptor\": \"\",\n \"tax_code\": \"\",\n \"unit_label\": \"\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "51c8e39d-9766-4b7c-84a2-d9e30cf8bd1f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4bb320fc-f409-49b9-997a-245b333399d8", "documentation": "

Returns a list of your promotion codes.

", "method": "get", "endpoint": "v1/promotion_codes", "responses": [ { "uuid": "dd768176-0703-4b9b-98e0-e93174f6b0dc", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ec5c0137-ea09-41d8-9779-7a4e05b459f5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7c39a18-74bf-41e8-b5eb-ffb732907658", "documentation": "

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

", "method": "post", "endpoint": "v1/promotion_codes", "responses": [ { "uuid": "ea694b77-68c4-49af-91e4-46252599a26b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "aa8d07d0-2961-4fc1-a791-fe3d82a9d350", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7d0ea83-972a-461d-a66b-18eb6e349e7c", "documentation": "

Retrieves the promotion code with the given ID.

", "method": "get", "endpoint": "v1/promotion_codes/:promotion_code", "responses": [ { "uuid": "f2b80a44-bfd1-48ff-aa5b-c09a7467d3b4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bf4dbfdf-cea9-41bc-8679-e16dfc30b3d0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "356427c2-b051-41bd-8f2b-729bca7e0654", "documentation": "

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

", "method": "post", "endpoint": "v1/promotion_codes/:promotion_code", "responses": [ { "uuid": "623c2a1f-0388-462f-8127-812902a6fb37", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "364b1994-5ba3-49c7-8b9f-8a7fffe3423d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c759127-5ad6-41ea-ab10-092a17d97ec9", "documentation": "

Returns a list of your quotes.

", "method": "get", "endpoint": "v1/quotes", "responses": [ { "uuid": "90218fc7-0cfa-4b02-af0f-60c71909edda", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "c1ac83ff-6c3e-4832-93b1-eb244e296e6a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fadfe152-d494-4672-b805-15adbfd34266", "documentation": "

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

", "method": "post", "endpoint": "v1/quotes", "responses": [ { "uuid": "52ce80dd-ccdc-4c26-a5e4-31389d2dc3d7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "010df821-8b20-4c81-accd-30238f45f076", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "473cb41b-7dba-477b-a27f-80a8d65b1e5f", "documentation": "

Retrieves the quote with the given ID.

", "method": "get", "endpoint": "v1/quotes/:quote", "responses": [ { "uuid": "cd3f8ca3-fc1e-4e01-a2f1-fc31f0a2aa18", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "38c7d7b7-8db1-4793-b849-031c3d944964", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba2ee24a-35b1-411a-8258-a366bab8956d", "documentation": "

A quote models prices and services for a customer.

", "method": "post", "endpoint": "v1/quotes/:quote", "responses": [ { "uuid": "811add3e-7467-465e-b163-9f3efa3ff422", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d23524b2-1cc5-40e4-80a5-7a946fd3d1eb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1134ee1d-c887-458b-84c7-e30dbbe111a6", "documentation": "

Accepts the specified quote.

", "method": "post", "endpoint": "v1/quotes/:quote/accept", "responses": [ { "uuid": "7915e65f-61ee-4e14-a894-53dc464db0a0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "18280fcc-69ae-4343-a3e0-b5f8a203de30", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b478add0-becd-41f6-bcd6-1722092afe19", "documentation": "

Cancels the quote.

", "method": "post", "endpoint": "v1/quotes/:quote/cancel", "responses": [ { "uuid": "79c8fdd2-4518-4685-a7f0-7c6350fe920b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "73a81cee-37cf-4faa-acba-fff11e52c336", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9f44f0f1-07bb-4949-ae3b-85e97d8a8236", "documentation": "

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

", "method": "get", "endpoint": "v1/quotes/:quote/computed_upfront_line_items", "responses": [ { "uuid": "d212ee23-378c-4cb8-bff2-aa248c64c68b", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2f2573a0-79ac-4b9e-80f2-b135dbcedacd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4fcaebd9-ccad-494d-b4a0-db2bdef3fbec", "documentation": "

Finalizes the quote.

", "method": "post", "endpoint": "v1/quotes/:quote/finalize", "responses": [ { "uuid": "ee21043d-ffcc-4b65-92f6-edafef1413b0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "8f6362be-6f9d-4527-83e2-e44ed6ce0ba4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c783c8a-6434-4360-9dcc-574cf664075c", "documentation": "

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "method": "get", "endpoint": "v1/quotes/:quote/line_items", "responses": [ { "uuid": "fc197725-262d-4291-b57e-420d836df41b", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "8edfaeab-4d55-4c6a-af44-93b95d004c4a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4997630-af69-48d7-8521-d54f142d796f", "documentation": "

Download the PDF for a finalized quote

", "method": "get", "endpoint": "v1/quotes/:quote/pdf", "responses": [ { "uuid": "07c6dc17-9e4e-4a2d-b15d-9061df8b8d9b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/pdf" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "742df6d0-a46f-4beb-a28e-bb791219604b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0cef257-f6b1-48c3-ab99-8bf86cf82969", "documentation": "

Returns a list of early fraud warnings.

", "method": "get", "endpoint": "v1/radar/early_fraud_warnings", "responses": [ { "uuid": "e591cfee-cf33-4ff8-8d42-ada0ff7c3385", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9b4e0a56-c91c-4d39-bf80-37f0e32fbd9c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8392e005-3467-4d0b-9383-b4ceef786425", "documentation": "

Retrieves the details of an early fraud warning that has previously been created.

\n\n

Please refer to the early fraud warning object reference for more details.

", "method": "get", "endpoint": "v1/radar/early_fraud_warnings/:early_fraud_warning", "responses": [ { "uuid": "7c93843e-7e07-4689-b59a-218cc8791b90", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2069610b-5f12-41f1-a597-abfc4bc92dde", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cecaa58d-b5c4-46ab-ab14-392bde744b2c", "documentation": "

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/radar/value_list_items", "responses": [ { "uuid": "fbfb93c8-03f0-4790-b283-9f3e0451f50d", "body": "{\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1998dd01-a6de-4037-88ac-5bf2b444a263", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "322c7daf-c48a-4f2d-be51-9a5636d1d706", "documentation": "

Creates a new ValueListItem object, which is added to the specified parent value list.

", "method": "post", "endpoint": "v1/radar/value_list_items", "responses": [ { "uuid": "5da557a6-f688-49c8-a0b6-9bc1360ff80f", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e7b26445-16f2-4331-8891-286dad14f12b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a8ad6137-5266-422e-9ea5-ce1ce8076820", "documentation": "

Deletes a ValueListItem object, removing it from its parent value list.

", "method": "delete", "endpoint": "v1/radar/value_list_items/:item", "responses": [ { "uuid": "cbfeb2f5-7345-419e-8c35-bc8a279dc25d", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "eb2a4229-71f6-418f-8516-d7e69bd8f6ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa089fc2-0cdf-4b84-9935-9c780daf6cbb", "documentation": "

Retrieves a ValueListItem object.

", "method": "get", "endpoint": "v1/radar/value_list_items/:item", "responses": [ { "uuid": "8641d471-7ea3-42ad-a97a-b41fe4dfb039", "body": "{\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "16bad602-8b17-4b74-b8a6-558a86a6bcba", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8afb0e01-f0e2-4635-815c-97ac29048ce5", "documentation": "

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/radar/value_lists", "responses": [ { "uuid": "1f421e51-1243-4f78-a385-ad123e066af0", "body": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"item_type\": \"{{oneOf (array 'card_bin' 'card_fingerprint' 'case_sensitive_string' 'country' 'email' 'ip_address' 'string')}}\",\n \"list_items\": {\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0fc7c107-a2f3-4558-96a0-c20e7f58a5a4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "70c31da0-ef19-4eb7-87a7-00d1ad540b05", "documentation": "

Creates a new ValueList object, which can then be referenced in rules.

", "method": "post", "endpoint": "v1/radar/value_lists", "responses": [ { "uuid": "e07bdf76-ef8c-4c4b-ac4e-faa2cecd3543", "body": "{\n \"alias\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"item_type\": \"{{oneOf (array 'card_bin' 'card_fingerprint' 'case_sensitive_string' 'country' 'email' 'ip_address' 'string')}}\",\n \"list_items\": {\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "db59405d-ef2f-4753-894a-3d835eeab3fe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cfb96704-b6f3-4a40-9153-f7bffa1c8496", "documentation": "

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

", "method": "delete", "endpoint": "v1/radar/value_lists/:value_list", "responses": [ { "uuid": "704a32b2-9107-42bc-8f64-008a793390e5", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "d23eccd7-1f8e-4f29-9257-e8578ed41d77", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2a7123ea-9498-4dd6-bf77-de82dac041dd", "documentation": "

Retrieves a ValueList object.

", "method": "get", "endpoint": "v1/radar/value_lists/:value_list", "responses": [ { "uuid": "5d6cf91a-b77c-4f63-a60e-f39406cc7c22", "body": "{\n \"alias\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"item_type\": \"{{oneOf (array 'card_bin' 'card_fingerprint' 'case_sensitive_string' 'country' 'email' 'ip_address' 'string')}}\",\n \"list_items\": {\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b851adba-e344-4093-a250-59e9a4d7b3c7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7719a0da-0105-4091-b0d0-e3339551bc2d", "documentation": "

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

", "method": "post", "endpoint": "v1/radar/value_lists/:value_list", "responses": [ { "uuid": "7b020a52-06ec-49f7-8823-d1c0c640685d", "body": "{\n \"alias\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"item_type\": \"{{oneOf (array 'card_bin' 'card_fingerprint' 'case_sensitive_string' 'country' 'email' 'ip_address' 'string')}}\",\n \"list_items\": {\n \"data\": [\n {\n \"created\": {{faker 'number.int' max=99999}},\n \"created_by\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'radar.value_list_item')}}\",\n \"value\": \"\",\n \"value_list\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'radar.value_list')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "aa092045-925f-4c15-bda6-542c324501a1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9355c683-d43d-4fab-a811-a326c15a7c27", "documentation": "

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

", "method": "get", "endpoint": "v1/recipients", "responses": [ { "uuid": "40d421ee-9720-4c9b-a590-31bba3fc26d9", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bf2d8a6a-7c68-476b-b7e3-42631d0aedfd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a26dcdd7-b01f-4afe-ba94-0a8099670ee8", "documentation": "

Creates a new Recipient object and verifies the recipient’s identity.\nAlso verifies the recipient’s bank account information or debit card, if either is provided.

", "method": "post", "endpoint": "v1/recipients", "responses": [ { "uuid": "e9d15bde-0916-4e1d-8de4-ac26323563af", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "43f3f31b-0b4a-4a52-afc6-bd66d57cba4b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c909bbf5-dd6f-418c-9201-7093031f52c1", "documentation": "

Permanently deletes a recipient. It cannot be undone.

", "method": "delete", "endpoint": "v1/recipients/:id", "responses": [ { "uuid": "57cdacaa-5115-4571-adbd-57bb8058077b", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'recipient')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4e55fa29-1aa9-4f8f-bbe0-c32e0eecf6c3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aed7bbb2-67a9-4163-86c8-06d4f6f7725b", "documentation": "

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

", "method": "get", "endpoint": "v1/recipients/:id", "responses": [ { "uuid": "82a3e47e-2973-403f-92a0-fcde0752cf50", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bc673950-577c-4177-a539-43ef04acd0d8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c2e0376-d444-46d8-b1b0-1ada170965ef", "documentation": "

Updates the specified recipient by setting the values of the parameters passed.\nAny parameters not provided will be left unchanged.

\n\n

If you update the name or tax ID, the identity verification will automatically be rerun.\nIf you update the bank account, the bank account validation will automatically be rerun.

", "method": "post", "endpoint": "v1/recipients/:id", "responses": [ { "uuid": "944c84b9-b7a7-4145-aaef-1b878ee2c168", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fbcca269-7624-4f20-9997-325c62b6fd37", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dbcdc4d0-94ee-490a-93c7-72f58cb55db7", "documentation": "

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

", "method": "get", "endpoint": "v1/refunds", "responses": [ { "uuid": "0aae6f50-81e1-420d-976d-ba1326a405b2", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7c3d5bdc-7826-4a36-9276-cee60677e43e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77c3797d-e03d-4c28-b730-de9be189acb5", "documentation": "

Create a refund.

", "method": "post", "endpoint": "v1/refunds", "responses": [ { "uuid": "feddc515-1de3-428b-b6b6-9cdf52a69b8a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a7865a9b-d51e-412e-bcc8-bdc85fd51418", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84829971-1148-4c66-8a09-efc098740505", "documentation": "

Retrieves the details of an existing refund.

", "method": "get", "endpoint": "v1/refunds/:refund", "responses": [ { "uuid": "a395f023-5f14-4b06-9f08-fc021594a79f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b763b5fc-9acc-416a-988e-0ce8c844a519", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "621aa2f2-b2fb-4965-90d0-81d1dba528eb", "documentation": "

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

", "method": "post", "endpoint": "v1/refunds/:refund", "responses": [ { "uuid": "176d04a4-e62b-404d-9959-926e004533a2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a22eec84-fd7a-4495-ae42-3820a5dd8d41", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a285ab64-2844-497c-9e63-fabc3e372f69", "documentation": "

Returns a list of Report Runs, with the most recent appearing first.

", "method": "get", "endpoint": "v1/reporting/report_runs", "responses": [ { "uuid": "60fd4160-6258-4fb3-a998-e16d573bd4f8", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e46c8fc7-6355-4e9b-82b0-f1e8e003d996", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "28a2eb05-27fd-4b15-994f-0fe4cbaa7fa3", "documentation": "

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

", "method": "post", "endpoint": "v1/reporting/report_runs", "responses": [ { "uuid": "0773ddd9-72e0-4496-b7e0-94b5571a7b82", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9a78b231-9256-4f7d-879a-455ce880f08f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "777de368-7a8e-494a-ad82-f461f98a9816", "documentation": "

Retrieves the details of an existing Report Run.

", "method": "get", "endpoint": "v1/reporting/report_runs/:report_run", "responses": [ { "uuid": "2cad0dc1-7d78-435c-8cab-2ec634c062dc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1934a6ce-63bb-4a5c-9af4-f466d1960dbd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14f2c00b-2239-4ffe-9b55-11b673f217e6", "documentation": "

Returns a full list of Report Types.

", "method": "get", "endpoint": "v1/reporting/report_types", "responses": [ { "uuid": "fe80d6f0-ba0c-489e-ac96-829802f52031", "body": "{\n \"data\": [\n {\n \"data_available_end\": {{faker 'number.int' max=99999}},\n \"data_available_start\": {{faker 'number.int' max=99999}},\n \"default_columns\": [\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'reporting.report_type')}}\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"version\": {{faker 'number.int' max=99999}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3362ce91-c53d-4a3a-8f29-d65d9b234b84", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b77bc810-4109-4bdd-8b2f-42ff696db0fd", "documentation": "

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

", "method": "get", "endpoint": "v1/reporting/report_types/:report_type", "responses": [ { "uuid": "7aa2edb0-bc71-4482-bc4a-c22037a07265", "body": "{\n \"data_available_end\": {{faker 'number.int' max=99999}},\n \"data_available_start\": {{faker 'number.int' max=99999}},\n \"default_columns\": [\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'reporting.report_type')}}\",\n \"updated\": {{faker 'number.int' max=99999}},\n \"version\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "746fae58-f20d-496b-98ec-155cd0b93412", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "206ba61f-8dde-4ef9-81e7-6a50aebdd8a0", "documentation": "

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "method": "get", "endpoint": "v1/reviews", "responses": [ { "uuid": "87b6f329-fd8e-47c5-b00b-4a71cad1f960", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ae821772-9567-45b4-9c4b-3b30cf512022", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c06713f3-4dcc-479b-9229-aa9a50ad6115", "documentation": "

Retrieves a Review object.

", "method": "get", "endpoint": "v1/reviews/:review", "responses": [ { "uuid": "531532e3-fb02-4354-ae2c-e56a6ccf59b8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "99701c9d-fbd9-48ec-9805-baab2165a88b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2158ba2e-d8f1-49c3-8c4c-ab8942ec9b0f", "documentation": "

Approves a Review object, closing it and removing it from the list of reviews.

", "method": "post", "endpoint": "v1/reviews/:review/approve", "responses": [ { "uuid": "fd96c38f-ad12-47aa-ad7a-ce585d4a5c28", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "00e1afcc-6e38-40f3-8392-0b5443625a25", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4d57264-c469-4e6b-a62a-6dce378d1865", "documentation": "

Returns a list of SetupAttempts associated with a provided SetupIntent.

", "method": "get", "endpoint": "v1/setup_attempts", "responses": [ { "uuid": "067d020b-614b-4c12-8b49-3ee23bacad6e", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3f2e5d41-ea18-4abf-95c9-3d799813d976", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "626bb1ef-e873-4279-9e2d-d84499d13f28", "documentation": "

Returns a list of SetupIntents.

", "method": "get", "endpoint": "v1/setup_intents", "responses": [ { "uuid": "44d7aef1-442b-455b-a973-2ca1f8ad39ed", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4773a044-45ad-4d34-9ecd-b7034604045b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d858cee-b535-4680-a5e3-323a606915d2", "documentation": "

Creates a SetupIntent object.

\n\n

After the SetupIntent is created, attach a payment method and confirm\nto collect any required permissions to charge the payment method later.

", "method": "post", "endpoint": "v1/setup_intents", "responses": [ { "uuid": "ebebd1e6-3922-45ea-85f4-c8f37de405d4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "89feac85-fbde-4f12-a95c-b03b605ca514", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2eb4bca6-d97a-44e6-972f-bd6f5b9d873b", "documentation": "

Retrieves the details of a SetupIntent that has previously been created.

\n\n

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

\n\n

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

", "method": "get", "endpoint": "v1/setup_intents/:intent", "responses": [ { "uuid": "01851132-a366-4cfe-97ef-d8c9fd49b0fe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7b131b44-353c-4993-9b72-bd96150ce791", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "119d606f-aa0f-455c-b275-dd1b9039c1a3", "documentation": "

Updates a SetupIntent object.

", "method": "post", "endpoint": "v1/setup_intents/:intent", "responses": [ { "uuid": "fad802d2-00e7-425f-86d2-85840f2d4dfa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "17e77f8c-25d8-4ac8-b436-a73f8a39cb9f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c2321f04-5712-467b-a58a-267040be0e05", "documentation": "

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n\n

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

", "method": "post", "endpoint": "v1/setup_intents/:intent/cancel", "responses": [ { "uuid": "07889776-b715-4148-b68a-2d35fbac506c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "887f0416-ad2b-45f8-a094-e918de585779", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c55d958-fff6-490f-bb81-f16fcff80447", "documentation": "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status.

", "method": "post", "endpoint": "v1/setup_intents/:intent/confirm", "responses": [ { "uuid": "3b63e6b4-0881-4f54-83b1-9090fe6780ae", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3e2da859-a7ec-446f-8d59-84d92fc3c0b3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1da12035-5259-422a-ba0b-c6f0ff2f9c9b", "documentation": "

Returns a list of scheduled query runs.

", "method": "get", "endpoint": "v1/sigma/scheduled_query_runs", "responses": [ { "uuid": "c693bfe4-c9e8-461e-b359-70ca8c1524a6", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a911a564-1648-4ba7-9517-e45f9e424de8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc6ded5e-8cb9-46f4-92b2-4cfc8a0862c2", "documentation": "

Retrieves the details of an scheduled query run.

", "method": "get", "endpoint": "v1/sigma/scheduled_query_runs/:scheduled_query_run", "responses": [ { "uuid": "27aa6e53-28c5-4533-9065-cfa9357fb2fb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7e4e3c94-f6fd-45d5-af31-6142adec8cf1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67e8df17-0c88-427e-95ed-1bfa96fe332c", "documentation": "

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

", "method": "get", "endpoint": "v1/skus", "responses": [ { "uuid": "534dd764-1cc9-4602-acf4-14346e2244bc", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"attributes\": {},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"inventory\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\",\n \"value\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'sku')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"price\": {{faker 'number.int' max=99999}},\n \"product\": \"\",\n \"updated\": {{faker 'number.int' max=99999}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0daee604-5a65-42fa-9f04-3c7bfbcef48d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8de4892f-28eb-440d-98cc-99f8c9147c1c", "documentation": "

Creates a new SKU associated with a product.

", "method": "post", "endpoint": "v1/skus", "responses": [ { "uuid": "d6a9097d-6051-4a88-9aa7-40dcaf1702ee", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"attributes\": {},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"inventory\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\",\n \"value\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'sku')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"price\": {{faker 'number.int' max=99999}},\n \"product\": \"\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "eb6233eb-6261-4ba5-8e29-1d7f3a81c384", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0160ae3e-6c66-4125-a305-0ed926fff0de", "documentation": "

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

", "method": "delete", "endpoint": "v1/skus/:id", "responses": [ { "uuid": "102bd7b2-871b-4265-a0f9-f8e47c0f929d", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'sku')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "72bca784-c572-41d4-85ba-85317b47ab36", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87cb482d-ffd3-40c3-97f3-28ddff460839", "documentation": "

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

", "method": "get", "endpoint": "v1/skus/:id", "responses": [ { "uuid": "fa3c595d-8c37-476d-8345-d26bd1c6c57a", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"attributes\": {},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"inventory\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\",\n \"value\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'sku')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"price\": {{faker 'number.int' max=99999}},\n \"product\": \"\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b31701af-5fcf-4eae-8e69-deaf1e51389e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee84c6b1-8c11-4aa4-b467-5b2d084079f7", "documentation": "

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

", "method": "post", "endpoint": "v1/skus/:id", "responses": [ { "uuid": "2ee16d2b-a248-44b5-83d6-864073d16446", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"attributes\": {},\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"inventory\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\",\n \"value\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'sku')}}\",\n \"package_dimensions\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"weight\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"price\": {{faker 'number.int' max=99999}},\n \"product\": \"\",\n \"updated\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "10ed4648-8dc1-45e9-a5a6-6526f02302f2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f57ce62-90b4-465b-8876-1e4fe947d818", "documentation": "

Creates a new source object.

", "method": "post", "endpoint": "v1/sources", "responses": [ { "uuid": "f1278370-e48c-480e-b32d-2a63bb19fcac", "body": "{\n \"ach_credit_transfer\": {\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"fingerprint\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_account_holder_type\": \"\",\n \"refund_routing_number\": \"\",\n \"routing_number\": \"\",\n \"swift_code\": \"\"\n },\n \"ach_debit\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\",\n \"type\": \"\"\n },\n \"acss_debit\": {\n \"bank_address_city\": \"\",\n \"bank_address_line_1\": \"\",\n \"bank_address_line_2\": \"\",\n \"bank_address_postal_code\": \"\",\n \"bank_name\": \"\",\n \"category\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"alipay\": {\n \"data_string\": \"\",\n \"native_url\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"au_becs_debit\": {\n \"bsb_number\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\"\n },\n \"bancontact\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"card\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"card_present\": {\n \"application_cryptogram\": \"\",\n \"application_preferred_name\": \"\",\n \"authorization_code\": \"\",\n \"authorization_response_code\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvm_type\": \"\",\n \"data_type\": \"\",\n \"dedicated_file_name\": \"\",\n \"emv_auth_data\": \"\",\n \"evidence_customer_signature\": \"\",\n \"evidence_transaction_certificate\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"pos_device_id\": \"\",\n \"pos_entry_mode\": \"\",\n \"read_method\": \"\",\n \"reader\": \"\",\n \"terminal_verification_results\": \"\",\n \"transaction_status_information\": \"\"\n },\n \"client_secret\": \"\",\n \"code_verification\": {\n \"attempts_remaining\": {{faker 'number.int' max=99999}},\n \"status\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"eps\": {\n \"reference\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"flow\": \"\",\n \"giropay\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"id\": \"\",\n \"ideal\": {\n \"bank\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"klarna\": {\n \"background_image_url\": \"\",\n \"client_token\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locale\": \"\",\n \"logo_url\": \"\",\n \"page_title\": \"\",\n \"pay_later_asset_urls_descriptive\": \"\",\n \"pay_later_asset_urls_standard\": \"\",\n \"pay_later_name\": \"\",\n \"pay_later_redirect_url\": \"\",\n \"pay_now_asset_urls_descriptive\": \"\",\n \"pay_now_asset_urls_standard\": \"\",\n \"pay_now_name\": \"\",\n \"pay_now_redirect_url\": \"\",\n \"pay_over_time_asset_urls_descriptive\": \"\",\n \"pay_over_time_asset_urls_standard\": \"\",\n \"pay_over_time_name\": \"\",\n \"pay_over_time_redirect_url\": \"\",\n \"payment_method_categories\": \"\",\n \"purchase_country\": \"\",\n \"purchase_type\": \"\",\n \"redirect_url\": \"\",\n \"shipping_delay\": {{faker 'number.int' max=99999}},\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"multibanco\": {\n \"entity\": \"\",\n \"reference\": \"\",\n \"refund_account_holder_address_city\": \"\",\n \"refund_account_holder_address_country\": \"\",\n \"refund_account_holder_address_line1\": \"\",\n \"refund_account_holder_address_line2\": \"\",\n \"refund_account_holder_address_postal_code\": \"\",\n \"refund_account_holder_address_state\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_iban\": \"\"\n },\n \"object\": \"{{oneOf (array 'source')}}\",\n \"owner\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"verified_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"verified_email\": \"\",\n \"verified_name\": \"\",\n \"verified_phone\": \"\"\n },\n \"p24\": {\n \"reference\": \"\"\n },\n \"receiver\": {\n \"address\": \"\",\n \"amount_charged\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"amount_returned\": {{faker 'number.int' max=99999}},\n \"refund_attributes_method\": \"\",\n \"refund_attributes_status\": \"\"\n },\n \"redirect\": {\n \"failure_reason\": \"\",\n \"return_url\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n },\n \"sepa_debit\": {\n \"bank_code\": \"\",\n \"branch_code\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\",\n \"mandate_url\": \"\"\n },\n \"sofort\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"country\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"source_order\": {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"email\": \"\",\n \"items\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"description\": \"\",\n \"parent\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n }\n ],\n \"shipping\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"carrier\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"tracking_number\": \"\"\n }\n },\n \"statement_descriptor\": \"\",\n \"status\": \"\",\n \"three_d_secure\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"authenticated\": {{faker 'datatype.boolean'}},\n \"brand\": \"\",\n \"card\": \"\",\n \"country\": \"\",\n \"customer\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'acss_debit' 'alipay' 'au_becs_debit' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\",\n \"usage\": \"\",\n \"wechat\": {\n \"prepay_id\": \"\",\n \"qr_code_url\": \"\",\n \"statement_descriptor\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "101a2928-85a2-4e6f-a189-7608ea40b166", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e10a1d2a-a360-4cf1-abbb-04bd0096532a", "documentation": "

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

", "method": "get", "endpoint": "v1/sources/:source", "responses": [ { "uuid": "116a91b0-fa4a-4809-accd-41b8af981091", "body": "{\n \"ach_credit_transfer\": {\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"fingerprint\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_account_holder_type\": \"\",\n \"refund_routing_number\": \"\",\n \"routing_number\": \"\",\n \"swift_code\": \"\"\n },\n \"ach_debit\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\",\n \"type\": \"\"\n },\n \"acss_debit\": {\n \"bank_address_city\": \"\",\n \"bank_address_line_1\": \"\",\n \"bank_address_line_2\": \"\",\n \"bank_address_postal_code\": \"\",\n \"bank_name\": \"\",\n \"category\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"alipay\": {\n \"data_string\": \"\",\n \"native_url\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"au_becs_debit\": {\n \"bsb_number\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\"\n },\n \"bancontact\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"card\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"card_present\": {\n \"application_cryptogram\": \"\",\n \"application_preferred_name\": \"\",\n \"authorization_code\": \"\",\n \"authorization_response_code\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvm_type\": \"\",\n \"data_type\": \"\",\n \"dedicated_file_name\": \"\",\n \"emv_auth_data\": \"\",\n \"evidence_customer_signature\": \"\",\n \"evidence_transaction_certificate\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"pos_device_id\": \"\",\n \"pos_entry_mode\": \"\",\n \"read_method\": \"\",\n \"reader\": \"\",\n \"terminal_verification_results\": \"\",\n \"transaction_status_information\": \"\"\n },\n \"client_secret\": \"\",\n \"code_verification\": {\n \"attempts_remaining\": {{faker 'number.int' max=99999}},\n \"status\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"eps\": {\n \"reference\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"flow\": \"\",\n \"giropay\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"id\": \"\",\n \"ideal\": {\n \"bank\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"klarna\": {\n \"background_image_url\": \"\",\n \"client_token\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locale\": \"\",\n \"logo_url\": \"\",\n \"page_title\": \"\",\n \"pay_later_asset_urls_descriptive\": \"\",\n \"pay_later_asset_urls_standard\": \"\",\n \"pay_later_name\": \"\",\n \"pay_later_redirect_url\": \"\",\n \"pay_now_asset_urls_descriptive\": \"\",\n \"pay_now_asset_urls_standard\": \"\",\n \"pay_now_name\": \"\",\n \"pay_now_redirect_url\": \"\",\n \"pay_over_time_asset_urls_descriptive\": \"\",\n \"pay_over_time_asset_urls_standard\": \"\",\n \"pay_over_time_name\": \"\",\n \"pay_over_time_redirect_url\": \"\",\n \"payment_method_categories\": \"\",\n \"purchase_country\": \"\",\n \"purchase_type\": \"\",\n \"redirect_url\": \"\",\n \"shipping_delay\": {{faker 'number.int' max=99999}},\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"multibanco\": {\n \"entity\": \"\",\n \"reference\": \"\",\n \"refund_account_holder_address_city\": \"\",\n \"refund_account_holder_address_country\": \"\",\n \"refund_account_holder_address_line1\": \"\",\n \"refund_account_holder_address_line2\": \"\",\n \"refund_account_holder_address_postal_code\": \"\",\n \"refund_account_holder_address_state\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_iban\": \"\"\n },\n \"object\": \"{{oneOf (array 'source')}}\",\n \"owner\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"verified_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"verified_email\": \"\",\n \"verified_name\": \"\",\n \"verified_phone\": \"\"\n },\n \"p24\": {\n \"reference\": \"\"\n },\n \"receiver\": {\n \"address\": \"\",\n \"amount_charged\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"amount_returned\": {{faker 'number.int' max=99999}},\n \"refund_attributes_method\": \"\",\n \"refund_attributes_status\": \"\"\n },\n \"redirect\": {\n \"failure_reason\": \"\",\n \"return_url\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n },\n \"sepa_debit\": {\n \"bank_code\": \"\",\n \"branch_code\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\",\n \"mandate_url\": \"\"\n },\n \"sofort\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"country\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"source_order\": {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"email\": \"\",\n \"items\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"description\": \"\",\n \"parent\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n }\n ],\n \"shipping\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"carrier\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"tracking_number\": \"\"\n }\n },\n \"statement_descriptor\": \"\",\n \"status\": \"\",\n \"three_d_secure\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"authenticated\": {{faker 'datatype.boolean'}},\n \"brand\": \"\",\n \"card\": \"\",\n \"country\": \"\",\n \"customer\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'acss_debit' 'alipay' 'au_becs_debit' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\",\n \"usage\": \"\",\n \"wechat\": {\n \"prepay_id\": \"\",\n \"qr_code_url\": \"\",\n \"statement_descriptor\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "27159786-5f7f-4fa0-a409-657dc6962eb2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52b3088b-5965-4158-a27f-242f6e5a2f83", "documentation": "

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

", "method": "post", "endpoint": "v1/sources/:source", "responses": [ { "uuid": "124f8316-b451-4203-9936-af635a14caef", "body": "{\n \"ach_credit_transfer\": {\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"fingerprint\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_account_holder_type\": \"\",\n \"refund_routing_number\": \"\",\n \"routing_number\": \"\",\n \"swift_code\": \"\"\n },\n \"ach_debit\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\",\n \"type\": \"\"\n },\n \"acss_debit\": {\n \"bank_address_city\": \"\",\n \"bank_address_line_1\": \"\",\n \"bank_address_line_2\": \"\",\n \"bank_address_postal_code\": \"\",\n \"bank_name\": \"\",\n \"category\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"alipay\": {\n \"data_string\": \"\",\n \"native_url\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"au_becs_debit\": {\n \"bsb_number\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\"\n },\n \"bancontact\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"card\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"card_present\": {\n \"application_cryptogram\": \"\",\n \"application_preferred_name\": \"\",\n \"authorization_code\": \"\",\n \"authorization_response_code\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvm_type\": \"\",\n \"data_type\": \"\",\n \"dedicated_file_name\": \"\",\n \"emv_auth_data\": \"\",\n \"evidence_customer_signature\": \"\",\n \"evidence_transaction_certificate\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"pos_device_id\": \"\",\n \"pos_entry_mode\": \"\",\n \"read_method\": \"\",\n \"reader\": \"\",\n \"terminal_verification_results\": \"\",\n \"transaction_status_information\": \"\"\n },\n \"client_secret\": \"\",\n \"code_verification\": {\n \"attempts_remaining\": {{faker 'number.int' max=99999}},\n \"status\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"eps\": {\n \"reference\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"flow\": \"\",\n \"giropay\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"id\": \"\",\n \"ideal\": {\n \"bank\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"klarna\": {\n \"background_image_url\": \"\",\n \"client_token\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locale\": \"\",\n \"logo_url\": \"\",\n \"page_title\": \"\",\n \"pay_later_asset_urls_descriptive\": \"\",\n \"pay_later_asset_urls_standard\": \"\",\n \"pay_later_name\": \"\",\n \"pay_later_redirect_url\": \"\",\n \"pay_now_asset_urls_descriptive\": \"\",\n \"pay_now_asset_urls_standard\": \"\",\n \"pay_now_name\": \"\",\n \"pay_now_redirect_url\": \"\",\n \"pay_over_time_asset_urls_descriptive\": \"\",\n \"pay_over_time_asset_urls_standard\": \"\",\n \"pay_over_time_name\": \"\",\n \"pay_over_time_redirect_url\": \"\",\n \"payment_method_categories\": \"\",\n \"purchase_country\": \"\",\n \"purchase_type\": \"\",\n \"redirect_url\": \"\",\n \"shipping_delay\": {{faker 'number.int' max=99999}},\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"multibanco\": {\n \"entity\": \"\",\n \"reference\": \"\",\n \"refund_account_holder_address_city\": \"\",\n \"refund_account_holder_address_country\": \"\",\n \"refund_account_holder_address_line1\": \"\",\n \"refund_account_holder_address_line2\": \"\",\n \"refund_account_holder_address_postal_code\": \"\",\n \"refund_account_holder_address_state\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_iban\": \"\"\n },\n \"object\": \"{{oneOf (array 'source')}}\",\n \"owner\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"verified_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"verified_email\": \"\",\n \"verified_name\": \"\",\n \"verified_phone\": \"\"\n },\n \"p24\": {\n \"reference\": \"\"\n },\n \"receiver\": {\n \"address\": \"\",\n \"amount_charged\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"amount_returned\": {{faker 'number.int' max=99999}},\n \"refund_attributes_method\": \"\",\n \"refund_attributes_status\": \"\"\n },\n \"redirect\": {\n \"failure_reason\": \"\",\n \"return_url\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n },\n \"sepa_debit\": {\n \"bank_code\": \"\",\n \"branch_code\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\",\n \"mandate_url\": \"\"\n },\n \"sofort\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"country\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"source_order\": {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"email\": \"\",\n \"items\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"description\": \"\",\n \"parent\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n }\n ],\n \"shipping\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"carrier\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"tracking_number\": \"\"\n }\n },\n \"statement_descriptor\": \"\",\n \"status\": \"\",\n \"three_d_secure\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"authenticated\": {{faker 'datatype.boolean'}},\n \"brand\": \"\",\n \"card\": \"\",\n \"country\": \"\",\n \"customer\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'acss_debit' 'alipay' 'au_becs_debit' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\",\n \"usage\": \"\",\n \"wechat\": {\n \"prepay_id\": \"\",\n \"qr_code_url\": \"\",\n \"statement_descriptor\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "19fa21a1-9e51-4645-b70d-c45dad8e64e9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0e06fb64-e304-4bc9-9a0e-abef244ad3b2", "documentation": "

Retrieves a new Source MandateNotification.

", "method": "get", "endpoint": "v1/sources/:source/mandate_notifications/:mandate_notification", "responses": [ { "uuid": "2a017ab5-683c-4672-9df0-78b74f935bd7", "body": "{\n \"acss_debit\": {\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"bacs_debit\": {\n \"last4\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'source_mandate_notification')}}\",\n \"reason\": \"\",\n \"sepa_debit\": {\n \"creditor_identifier\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\"\n },\n \"source\": {\n \"ach_credit_transfer\": {\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"fingerprint\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_account_holder_type\": \"\",\n \"refund_routing_number\": \"\",\n \"routing_number\": \"\",\n \"swift_code\": \"\"\n },\n \"ach_debit\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\",\n \"type\": \"\"\n },\n \"acss_debit\": {\n \"bank_address_city\": \"\",\n \"bank_address_line_1\": \"\",\n \"bank_address_line_2\": \"\",\n \"bank_address_postal_code\": \"\",\n \"bank_name\": \"\",\n \"category\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"alipay\": {\n \"data_string\": \"\",\n \"native_url\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"au_becs_debit\": {\n \"bsb_number\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\"\n },\n \"bancontact\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"card\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"card_present\": {\n \"application_cryptogram\": \"\",\n \"application_preferred_name\": \"\",\n \"authorization_code\": \"\",\n \"authorization_response_code\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvm_type\": \"\",\n \"data_type\": \"\",\n \"dedicated_file_name\": \"\",\n \"emv_auth_data\": \"\",\n \"evidence_customer_signature\": \"\",\n \"evidence_transaction_certificate\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"pos_device_id\": \"\",\n \"pos_entry_mode\": \"\",\n \"read_method\": \"\",\n \"reader\": \"\",\n \"terminal_verification_results\": \"\",\n \"transaction_status_information\": \"\"\n },\n \"client_secret\": \"\",\n \"code_verification\": {\n \"attempts_remaining\": {{faker 'number.int' max=99999}},\n \"status\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"eps\": {\n \"reference\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"flow\": \"\",\n \"giropay\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"id\": \"\",\n \"ideal\": {\n \"bank\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"klarna\": {\n \"background_image_url\": \"\",\n \"client_token\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locale\": \"\",\n \"logo_url\": \"\",\n \"page_title\": \"\",\n \"pay_later_asset_urls_descriptive\": \"\",\n \"pay_later_asset_urls_standard\": \"\",\n \"pay_later_name\": \"\",\n \"pay_later_redirect_url\": \"\",\n \"pay_now_asset_urls_descriptive\": \"\",\n \"pay_now_asset_urls_standard\": \"\",\n \"pay_now_name\": \"\",\n \"pay_now_redirect_url\": \"\",\n \"pay_over_time_asset_urls_descriptive\": \"\",\n \"pay_over_time_asset_urls_standard\": \"\",\n \"pay_over_time_name\": \"\",\n \"pay_over_time_redirect_url\": \"\",\n \"payment_method_categories\": \"\",\n \"purchase_country\": \"\",\n \"purchase_type\": \"\",\n \"redirect_url\": \"\",\n \"shipping_delay\": {{faker 'number.int' max=99999}},\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"multibanco\": {\n \"entity\": \"\",\n \"reference\": \"\",\n \"refund_account_holder_address_city\": \"\",\n \"refund_account_holder_address_country\": \"\",\n \"refund_account_holder_address_line1\": \"\",\n \"refund_account_holder_address_line2\": \"\",\n \"refund_account_holder_address_postal_code\": \"\",\n \"refund_account_holder_address_state\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_iban\": \"\"\n },\n \"object\": \"{{oneOf (array 'source')}}\",\n \"owner\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"verified_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"verified_email\": \"\",\n \"verified_name\": \"\",\n \"verified_phone\": \"\"\n },\n \"p24\": {\n \"reference\": \"\"\n },\n \"receiver\": {\n \"address\": \"\",\n \"amount_charged\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"amount_returned\": {{faker 'number.int' max=99999}},\n \"refund_attributes_method\": \"\",\n \"refund_attributes_status\": \"\"\n },\n \"redirect\": {\n \"failure_reason\": \"\",\n \"return_url\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n },\n \"sepa_debit\": {\n \"bank_code\": \"\",\n \"branch_code\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\",\n \"mandate_url\": \"\"\n },\n \"sofort\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"country\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"source_order\": {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"email\": \"\",\n \"items\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"description\": \"\",\n \"parent\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n }\n ],\n \"shipping\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"carrier\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"tracking_number\": \"\"\n }\n },\n \"statement_descriptor\": \"\",\n \"status\": \"\",\n \"three_d_secure\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"authenticated\": {{faker 'datatype.boolean'}},\n \"brand\": \"\",\n \"card\": \"\",\n \"country\": \"\",\n \"customer\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'acss_debit' 'alipay' 'au_becs_debit' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\",\n \"usage\": \"\",\n \"wechat\": {\n \"prepay_id\": \"\",\n \"qr_code_url\": \"\",\n \"statement_descriptor\": \"\"\n }\n },\n \"status\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "88483f84-ffd7-42f7-9b14-e5e2f69d5937", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "173f79bd-2abe-4c70-8c38-586cc358f243", "documentation": "

List source transactions for a given source.

", "method": "get", "endpoint": "v1/sources/:source/source_transactions", "responses": [ { "uuid": "6029e4fe-5c49-49ae-9fe3-25ca6066eb62", "body": "{\n \"data\": [\n {\n \"ach_credit_transfer\": {\n \"customer_data\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"chf_credit_transfer\": {\n \"reference\": \"\",\n \"sender_address_country\": \"\",\n \"sender_address_line1\": \"\",\n \"sender_iban\": \"\",\n \"sender_name\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"gbp_credit_transfer\": {\n \"fingerprint\": \"\",\n \"funding_method\": \"\",\n \"last4\": \"\",\n \"reference\": \"\",\n \"sender_account_number\": \"\",\n \"sender_name\": \"\",\n \"sender_sort_code\": \"\"\n },\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'source_transaction')}}\",\n \"paper_check\": {\n \"available_at\": \"\",\n \"invoices\": \"\"\n },\n \"sepa_credit_transfer\": {\n \"reference\": \"\",\n \"sender_iban\": \"\",\n \"sender_name\": \"\"\n },\n \"source\": \"\",\n \"status\": \"\",\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'alipay' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6335440b-641a-4f10-ad5a-8bb1f0169892", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ce522ef-f604-4444-aaff-9fb0f66f1d88", "documentation": "

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

", "method": "get", "endpoint": "v1/sources/:source/source_transactions/:source_transaction", "responses": [ { "uuid": "04423947-e85a-4012-b91f-8c8cc2871011", "body": "{\n \"ach_credit_transfer\": {\n \"customer_data\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"chf_credit_transfer\": {\n \"reference\": \"\",\n \"sender_address_country\": \"\",\n \"sender_address_line1\": \"\",\n \"sender_iban\": \"\",\n \"sender_name\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"gbp_credit_transfer\": {\n \"fingerprint\": \"\",\n \"funding_method\": \"\",\n \"last4\": \"\",\n \"reference\": \"\",\n \"sender_account_number\": \"\",\n \"sender_name\": \"\",\n \"sender_sort_code\": \"\"\n },\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'source_transaction')}}\",\n \"paper_check\": {\n \"available_at\": \"\",\n \"invoices\": \"\"\n },\n \"sepa_credit_transfer\": {\n \"reference\": \"\",\n \"sender_iban\": \"\",\n \"sender_name\": \"\"\n },\n \"source\": \"\",\n \"status\": \"\",\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'alipay' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "5e9c6063-b01e-43e0-b7c5-666a76a25911", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "79020716-aaff-434f-b465-a75f288f779a", "documentation": "

Verify a given source.

", "method": "post", "endpoint": "v1/sources/:source/verify", "responses": [ { "uuid": "f117dbe2-2400-4481-b22b-eaa9537bcfa4", "body": "{\n \"ach_credit_transfer\": {\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"fingerprint\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_account_holder_type\": \"\",\n \"refund_routing_number\": \"\",\n \"routing_number\": \"\",\n \"swift_code\": \"\"\n },\n \"ach_debit\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\",\n \"type\": \"\"\n },\n \"acss_debit\": {\n \"bank_address_city\": \"\",\n \"bank_address_line_1\": \"\",\n \"bank_address_line_2\": \"\",\n \"bank_address_postal_code\": \"\",\n \"bank_name\": \"\",\n \"category\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"routing_number\": \"\"\n },\n \"alipay\": {\n \"data_string\": \"\",\n \"native_url\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"amount\": {{faker 'number.int' max=99999}},\n \"au_becs_debit\": {\n \"bsb_number\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\"\n },\n \"bancontact\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"card\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"card_present\": {\n \"application_cryptogram\": \"\",\n \"application_preferred_name\": \"\",\n \"authorization_code\": \"\",\n \"authorization_response_code\": \"\",\n \"brand\": \"\",\n \"country\": \"\",\n \"cvm_type\": \"\",\n \"data_type\": \"\",\n \"dedicated_file_name\": \"\",\n \"emv_auth_data\": \"\",\n \"evidence_customer_signature\": \"\",\n \"evidence_transaction_certificate\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"pos_device_id\": \"\",\n \"pos_entry_mode\": \"\",\n \"read_method\": \"\",\n \"reader\": \"\",\n \"terminal_verification_results\": \"\",\n \"transaction_status_information\": \"\"\n },\n \"client_secret\": \"\",\n \"code_verification\": {\n \"attempts_remaining\": {{faker 'number.int' max=99999}},\n \"status\": \"\"\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"customer\": \"\",\n \"eps\": {\n \"reference\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"flow\": \"\",\n \"giropay\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"id\": \"\",\n \"ideal\": {\n \"bank\": \"\",\n \"bic\": \"\",\n \"iban_last4\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"klarna\": {\n \"background_image_url\": \"\",\n \"client_token\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locale\": \"\",\n \"logo_url\": \"\",\n \"page_title\": \"\",\n \"pay_later_asset_urls_descriptive\": \"\",\n \"pay_later_asset_urls_standard\": \"\",\n \"pay_later_name\": \"\",\n \"pay_later_redirect_url\": \"\",\n \"pay_now_asset_urls_descriptive\": \"\",\n \"pay_now_asset_urls_standard\": \"\",\n \"pay_now_name\": \"\",\n \"pay_now_redirect_url\": \"\",\n \"pay_over_time_asset_urls_descriptive\": \"\",\n \"pay_over_time_asset_urls_standard\": \"\",\n \"pay_over_time_name\": \"\",\n \"pay_over_time_redirect_url\": \"\",\n \"payment_method_categories\": \"\",\n \"purchase_country\": \"\",\n \"purchase_type\": \"\",\n \"redirect_url\": \"\",\n \"shipping_delay\": {{faker 'number.int' max=99999}},\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\"\n },\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"multibanco\": {\n \"entity\": \"\",\n \"reference\": \"\",\n \"refund_account_holder_address_city\": \"\",\n \"refund_account_holder_address_country\": \"\",\n \"refund_account_holder_address_line1\": \"\",\n \"refund_account_holder_address_line2\": \"\",\n \"refund_account_holder_address_postal_code\": \"\",\n \"refund_account_holder_address_state\": \"\",\n \"refund_account_holder_name\": \"\",\n \"refund_iban\": \"\"\n },\n \"object\": \"{{oneOf (array 'source')}}\",\n \"owner\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"verified_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"verified_email\": \"\",\n \"verified_name\": \"\",\n \"verified_phone\": \"\"\n },\n \"p24\": {\n \"reference\": \"\"\n },\n \"receiver\": {\n \"address\": \"\",\n \"amount_charged\": {{faker 'number.int' max=99999}},\n \"amount_received\": {{faker 'number.int' max=99999}},\n \"amount_returned\": {{faker 'number.int' max=99999}},\n \"refund_attributes_method\": \"\",\n \"refund_attributes_status\": \"\"\n },\n \"redirect\": {\n \"failure_reason\": \"\",\n \"return_url\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n },\n \"sepa_debit\": {\n \"bank_code\": \"\",\n \"branch_code\": \"\",\n \"country\": \"\",\n \"fingerprint\": \"\",\n \"last4\": \"\",\n \"mandate_reference\": \"\",\n \"mandate_url\": \"\"\n },\n \"sofort\": {\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"bic\": \"\",\n \"country\": \"\",\n \"iban_last4\": \"\",\n \"preferred_language\": \"\",\n \"statement_descriptor\": \"\"\n },\n \"source_order\": {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"email\": \"\",\n \"items\": [\n {\n \"amount\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"description\": \"\",\n \"parent\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n }\n ],\n \"shipping\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"carrier\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"tracking_number\": \"\"\n }\n },\n \"statement_descriptor\": \"\",\n \"status\": \"\",\n \"three_d_secure\": {\n \"address_line1_check\": \"\",\n \"address_zip_check\": \"\",\n \"authenticated\": {{faker 'datatype.boolean'}},\n \"brand\": \"\",\n \"card\": \"\",\n \"country\": \"\",\n \"customer\": \"\",\n \"cvc_check\": \"\",\n \"dynamic_last4\": \"\",\n \"exp_month\": {{faker 'number.int' max=99999}},\n \"exp_year\": {{faker 'number.int' max=99999}},\n \"fingerprint\": \"\",\n \"funding\": \"\",\n \"last4\": \"\",\n \"name\": \"\",\n \"three_d_secure\": \"\",\n \"tokenization_method\": \"\"\n },\n \"type\": \"{{oneOf (array 'ach_credit_transfer' 'ach_debit' 'acss_debit' 'alipay' 'au_becs_debit' 'bancontact' 'card' 'card_present' 'eps' 'giropay' 'ideal' 'klarna' 'multibanco' 'p24' 'sepa_debit' 'sofort' 'three_d_secure' 'wechat')}}\",\n \"usage\": \"\",\n \"wechat\": {\n \"prepay_id\": \"\",\n \"qr_code_url\": \"\",\n \"statement_descriptor\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "13fd4b29-9065-4a11-8121-cac0dc4602f0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fb84a92e-e24e-46fd-8f2a-b4c7696d1954", "documentation": "

Returns a list of your subscription items for a given subscription.

", "method": "get", "endpoint": "v1/subscription_items", "responses": [ { "uuid": "5553eda1-3a8b-4c1b-89e9-04a57af8a980", "body": "{\n \"data\": [\n {\n \"billing_thresholds\": {\n \"usage_gte\": {{faker 'number.int' max=99999}}\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'subscription_item')}}\",\n \"price\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n },\n \"quantity\": {{faker 'number.int' max=99999}},\n \"subscription\": \"\",\n \"tax_rates\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n }\n ]\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1869b77d-858b-4a49-a61a-308a7073c5e1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f64baaa1-fa97-4164-8e7c-9cad6f3cc6c9", "documentation": "

Adds a new item to an existing subscription. No existing items will be changed or replaced.

", "method": "post", "endpoint": "v1/subscription_items", "responses": [ { "uuid": "8845b36a-0b9c-4ff3-b432-6efaebe12b5a", "body": "{\n \"billing_thresholds\": {\n \"usage_gte\": {{faker 'number.int' max=99999}}\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'subscription_item')}}\",\n \"price\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n },\n \"quantity\": {{faker 'number.int' max=99999}},\n \"subscription\": \"\",\n \"tax_rates\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b7079ce2-c52b-4a32-b57f-63432bf4934f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f0dfbda9-63bf-477b-8f33-5a5dbc83e707", "documentation": "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

", "method": "delete", "endpoint": "v1/subscription_items/:item", "responses": [ { "uuid": "b3155b80-5514-41ff-9a47-e2da2ee91d76", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'subscription_item')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7063efa6-05dd-44f3-98ca-c23697b756f5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a75627af-108f-438c-a02d-7ea7e4f425bc", "documentation": "

Retrieves the subscription item with the given ID.

", "method": "get", "endpoint": "v1/subscription_items/:item", "responses": [ { "uuid": "f26418f2-6735-4452-b3c4-1f156277af11", "body": "{\n \"billing_thresholds\": {\n \"usage_gte\": {{faker 'number.int' max=99999}}\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'subscription_item')}}\",\n \"price\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n },\n \"quantity\": {{faker 'number.int' max=99999}},\n \"subscription\": \"\",\n \"tax_rates\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6adb0f17-09f2-411c-8f2f-40b9c7e72fc9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cb748f3b-1c29-4cd3-90f6-eff76c126058", "documentation": "

Updates the plan or quantity of an item on a current subscription.

", "method": "post", "endpoint": "v1/subscription_items/:item", "responses": [ { "uuid": "3920e7b2-cfb3-4925-89e6-793e46e37e7c", "body": "{\n \"billing_thresholds\": {\n \"usage_gte\": {{faker 'number.int' max=99999}}\n },\n \"created\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'subscription_item')}}\",\n \"price\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"billing_scheme\": \"{{oneOf (array 'per_unit' 'tiered')}}\",\n \"created\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"lookup_key\": \"\",\n \"metadata\": {},\n \"nickname\": \"\",\n \"object\": \"{{oneOf (array 'price')}}\",\n \"product\": \"\",\n \"recurring\": {\n \"aggregate_usage\": \"{{oneOf (array 'last_during_period' 'last_ever' 'max' 'sum')}}\",\n \"interval\": \"{{oneOf (array 'day' 'month' 'week' 'year')}}\",\n \"interval_count\": {{faker 'number.int' max=99999}},\n \"usage_type\": \"{{oneOf (array 'licensed' 'metered')}}\"\n },\n \"tax_behavior\": \"{{oneOf (array 'exclusive' 'inclusive' 'unspecified')}}\",\n \"tiers\": [\n {\n \"flat_amount\": {{faker 'number.int' max=99999}},\n \"flat_amount_decimal\": \"\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\",\n \"up_to\": {{faker 'number.int' max=99999}}\n }\n ],\n \"tiers_mode\": \"{{oneOf (array 'graduated' 'volume')}}\",\n \"transform_quantity\": {\n \"divide_by\": {{faker 'number.int' max=99999}},\n \"round\": \"{{oneOf (array 'down' 'up')}}\"\n },\n \"type\": \"{{oneOf (array 'one_time' 'recurring')}}\",\n \"unit_amount\": {{faker 'number.int' max=99999}},\n \"unit_amount_decimal\": \"\"\n },\n \"quantity\": {{faker 'number.int' max=99999}},\n \"subscription\": \"\",\n \"tax_rates\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e7d5b853-f042-4617-845f-ebd66a10620c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "98356568-43b7-4714-931a-cc2ef9009805", "documentation": "

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

\n\n

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

", "method": "get", "endpoint": "v1/subscription_items/:subscription_item/usage_record_summaries", "responses": [ { "uuid": "e7eac18e-2730-43b5-8502-db30e0cfa504", "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"invoice\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'usage_record_summary')}}\",\n \"period\": {\n \"end\": {{faker 'number.int' max=99999}},\n \"start\": {{faker 'number.int' max=99999}}\n },\n \"subscription_item\": \"\",\n \"total_usage\": {{faker 'number.int' max=99999}}\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a0deed45-0c89-40a3-a98f-2e0bc1559aaa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d7871dc-a08e-4e9f-8414-cfdc63e4ae1d", "documentation": "

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

\n\n

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

\n\n

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

\n\n

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

", "method": "post", "endpoint": "v1/subscription_items/:subscription_item/usage_records", "responses": [ { "uuid": "cb5935b0-28e2-4149-806a-df2ab510aa39", "body": "{\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'usage_record')}}\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"subscription_item\": \"\",\n \"timestamp\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1391c56d-4b17-4383-9b61-388b2738dfbe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed4b6f59-d7c7-49e3-90f7-bdf0c8e51b4c", "documentation": "

Retrieves the list of your subscription schedules.

", "method": "get", "endpoint": "v1/subscription_schedules", "responses": [ { "uuid": "c1fae311-087f-47b9-a5c5-c97eba9ce0c0", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2363b6a9-e6e6-47a5-8620-7c2076d7ef3e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3e012542-594c-477f-be85-bc3f487d9e36", "documentation": "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

", "method": "post", "endpoint": "v1/subscription_schedules", "responses": [ { "uuid": "e072c613-df3a-4ac7-9b05-71c7e2a56ff7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fd06b656-f816-4263-91ee-634c5a5ab39c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c8b930fb-056d-4e3e-97c3-522f6ea51018", "documentation": "

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

", "method": "get", "endpoint": "v1/subscription_schedules/:schedule", "responses": [ { "uuid": "5a1d6cbc-1c73-426f-b67d-79fe2493773d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "aea86947-ba1c-4f48-8562-7a64230f60e0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "29ebd7a2-ae4f-48f5-9397-a3ba4624ede2", "documentation": "

Updates an existing subscription schedule.

", "method": "post", "endpoint": "v1/subscription_schedules/:schedule", "responses": [ { "uuid": "c9f4c59d-a729-4f4a-84a8-6bf69201545c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "81087d12-7953-45c3-97b9-e57520e86674", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f904ab12-f9d1-431d-a435-46c3a135db27", "documentation": "

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

", "method": "post", "endpoint": "v1/subscription_schedules/:schedule/cancel", "responses": [ { "uuid": "1a9b2537-bd9b-488c-a734-525431881b0c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "253a866b-a462-4359-acfc-f7fa119e97ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "74632657-68a1-4d20-88e0-cc92a86960d3", "documentation": "

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

", "method": "post", "endpoint": "v1/subscription_schedules/:schedule/release", "responses": [ { "uuid": "434b4f6a-6dc4-4e22-9eb0-428b559a11c3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1e98ce76-5bb2-460c-b566-03e0a3ed8d22", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed49b7c7-41c8-454d-9052-867d0b65f242", "documentation": "

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

", "method": "get", "endpoint": "v1/subscriptions", "responses": [ { "uuid": "c02a9470-9ca1-49e2-8345-c43d10524bfc", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "9a51c83d-113e-4a0a-ba64-3a3d30e285f0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8dec3831-820f-4b00-b25e-df440830ca75", "documentation": "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

", "method": "post", "endpoint": "v1/subscriptions", "responses": [ { "uuid": "4621f0c8-c04e-4928-972c-74c772f1f20b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4c051699-9373-4b2f-aa8b-f3907f62ccbe", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8487cfb5-bf4b-4827-8cec-895d7c9e2872", "documentation": "

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

", "method": "delete", "endpoint": "v1/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "6123d5e1-8ef0-4555-a43a-d1c4aca836d5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ddb7f986-4091-4669-b533-5d0be38dee53", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7cac2a91-615f-4454-904a-d1735ff8d4d2", "documentation": "

Retrieves the subscription with the given ID.

", "method": "get", "endpoint": "v1/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "cc55cebe-2d2d-483e-b505-157f4f5c2825", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f161c4f1-4c50-4d42-aead-e2c4c75d575f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e2e4c707-f50d-444a-9e0a-664a2bfdbfed", "documentation": "

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

", "method": "post", "endpoint": "v1/subscriptions/:subscription_exposed_id", "responses": [ { "uuid": "ca24ba51-a8cc-43bb-9342-c7d4f5121b48", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6183b7dd-ff3d-4171-84b5-fb348fe1f480", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fe3dc5b5-dbeb-4348-b2fc-ee3bbaad1342", "documentation": "

Removes the currently applied discount on a subscription.

", "method": "delete", "endpoint": "v1/subscriptions/:subscription_exposed_id/discount", "responses": [ { "uuid": "bbcca227-8d4b-4292-a9b9-467923963491", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0f6e3f86-1a80-4458-a675-054e349baf6e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9c60acf9-8919-4bea-9ebc-b1b7183178d2", "documentation": "

A list of all tax codes available to add to Products in order to allow specific tax calculations.

", "method": "get", "endpoint": "v1/tax_codes", "responses": [ { "uuid": "b66a418e-5bfc-438c-ab36-bb8477140d10", "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'tax_code')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "843f6172-7709-4723-8f2f-65975be60f11", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7088259e-13d3-4dae-b619-69660226e43c", "documentation": "

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

", "method": "get", "endpoint": "v1/tax_codes/:id", "responses": [ { "uuid": "c272065f-9a07-432e-9ec1-f489d657805b", "body": "{\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"object\": \"{{oneOf (array 'tax_code')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "eeab78b1-c2cf-47a9-b26f-e9ee0a0e3a92", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1832e85e-fd1a-4c15-a71d-f160f35e6df7", "documentation": "

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

", "method": "get", "endpoint": "v1/tax_rates", "responses": [ { "uuid": "f41e35e6-c1eb-4859-93ba-040a1b46fe1c", "body": "{\n \"data\": [\n {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "248b3def-f739-4083-a7a9-2e0c5c40bc61", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41bab879-059f-4ba0-a0df-b975bd813fd7", "documentation": "

Creates a new tax rate.

", "method": "post", "endpoint": "v1/tax_rates", "responses": [ { "uuid": "3c51f826-66f9-4678-9348-44002c662691", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "793980df-9b6b-480d-bb50-0065410f261e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a79f413-9a6d-4275-9bb0-339542e0f2d9", "documentation": "

Retrieves a tax rate with the given ID

", "method": "get", "endpoint": "v1/tax_rates/:tax_rate", "responses": [ { "uuid": "e7195882-494f-4531-8ef8-64591c057dfd", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e65af4db-d1e7-4750-bf8c-622b7634192b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ff1e0e0e-4179-49e5-9475-07f71cffcd3a", "documentation": "

Updates an existing tax rate.

", "method": "post", "endpoint": "v1/tax_rates/:tax_rate", "responses": [ { "uuid": "d771f65c-435b-478c-8638-3f67b519bcdf", "body": "{\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"inclusive\": {{faker 'datatype.boolean'}},\n \"jurisdiction\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'tax_rate')}}\",\n \"percentage\": {{faker 'number.int' max=99999}},\n \"state\": \"\",\n \"tax_type\": \"{{oneOf (array 'gst' 'hst' 'pst' 'qst' 'sales_tax' 'vat')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "6774585a-a5d5-4125-999c-4782d6106b51", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "608f752d-4c9d-46e5-b115-9c1a60973867", "documentation": "

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

", "method": "post", "endpoint": "v1/terminal/connection_tokens", "responses": [ { "uuid": "cb2cc6db-6c22-4f93-846e-54da14807bfb", "body": "{\n \"location\": \"\",\n \"object\": \"{{oneOf (array 'terminal.connection_token')}}\",\n \"secret\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "0ffda73e-da5f-475c-9da2-200d6266a366", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d693dc34-31e4-4719-8aaa-ab715431739e", "documentation": "

Returns a list of Location objects.

", "method": "get", "endpoint": "v1/terminal/locations", "responses": [ { "uuid": "73ae5f2f-d021-4a5b-a3c8-5713b222ac91", "body": "{\n \"data\": [\n {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"display_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.location')}}\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "7037186c-9203-4512-aed2-75a58452023a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d06d434b-9e39-452a-ae29-10c7f663b593", "documentation": "

Creates a new Location object.

", "method": "post", "endpoint": "v1/terminal/locations", "responses": [ { "uuid": "1c7329c2-3edf-47cc-9195-156a907accdd", "body": "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"display_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.location')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "41ccaa45-8a20-4c9f-b856-974ce7bd0a07", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ede83e54-5328-4337-a595-97f0c6833434", "documentation": "

Deletes a Location object.

", "method": "delete", "endpoint": "v1/terminal/locations/:location", "responses": [ { "uuid": "83e41430-bddf-485d-b9ca-e58396c45e9c", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'terminal.location')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "91b425b5-e70e-42f4-a09e-9448944115e0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b851aa1-4701-4848-aef9-38ae85685023", "documentation": "

Retrieves a Location object.

", "method": "get", "endpoint": "v1/terminal/locations/:location", "responses": [ { "uuid": "f12c0420-5457-4933-bb32-519eff0a9827", "body": "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"display_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.location')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "13f05097-340a-4801-a22e-6921a07854eb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c60e38da-7a81-4755-87ec-7d779e5796c0", "documentation": "

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/terminal/locations/:location", "responses": [ { "uuid": "8391f49c-7595-412e-9ab8-681e5d7f3f7a", "body": "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n },\n \"display_name\": \"\",\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.location')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "54833b9a-99f8-4168-b9a7-5e07b9affb8d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "200cf649-71cb-44e2-8cf3-5c6ab3aebd0b", "documentation": "

Returns a list of Reader objects.

", "method": "get", "endpoint": "v1/terminal/readers", "responses": [ { "uuid": "e195b848-5ed4-405d-932a-87a90faaccf0", "body": "{\n \"data\": [\n {\n \"device_sw_version\": \"\",\n \"device_type\": \"{{oneOf (array 'bbpos_chipper2x' 'verifone_P400')}}\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"label\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"location\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.reader')}}\",\n \"serial_number\": \"\",\n \"status\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "58a32f64-8cec-4217-a10a-65bc313ccb12", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6be72cb-8100-4bd3-ab74-0f59b2d28d69", "documentation": "

Creates a new Reader object.

", "method": "post", "endpoint": "v1/terminal/readers", "responses": [ { "uuid": "f1935ec0-cc3c-4e01-91f9-b36ce9eee525", "body": "{\n \"device_sw_version\": \"\",\n \"device_type\": \"{{oneOf (array 'bbpos_chipper2x' 'verifone_P400')}}\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"label\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"location\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.reader')}}\",\n \"serial_number\": \"\",\n \"status\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "15897a04-0d3b-4475-829f-d72d9340fc7c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa371b66-9b86-4a0f-ae43-029647759d96", "documentation": "

Deletes a Reader object.

", "method": "delete", "endpoint": "v1/terminal/readers/:reader", "responses": [ { "uuid": "f923eb1a-dccf-4cb0-8681-cbc339fba758", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'terminal.reader')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e50988db-3069-4db4-b780-8f0d94bd8256", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2aab6859-a9ee-4af1-8691-70df228104f0", "documentation": "

Retrieves a Reader object.

", "method": "get", "endpoint": "v1/terminal/readers/:reader", "responses": [ { "uuid": "96eae109-c546-4225-9b22-d1ac76180f8f", "body": "{\n \"device_sw_version\": \"\",\n \"device_type\": \"{{oneOf (array 'bbpos_chipper2x' 'verifone_P400')}}\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"label\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"location\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.reader')}}\",\n \"serial_number\": \"\",\n \"status\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1ab6065d-469c-46bc-b364-2d0bfc96e56a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e03e8ca7-3ff5-40ff-883c-9799f55e05a1", "documentation": "

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "method": "post", "endpoint": "v1/terminal/readers/:reader", "responses": [ { "uuid": "5fc31f45-02c9-4941-bec7-b5ca6ac5542a", "body": "{\n \"device_sw_version\": \"\",\n \"device_type\": \"{{oneOf (array 'bbpos_chipper2x' 'verifone_P400')}}\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"label\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"location\": \"\",\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'terminal.reader')}}\",\n \"serial_number\": \"\",\n \"status\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bec9da58-d077-4627-af28-0a402175a9a0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c51662a-3f63-420a-8de9-b046f5a1e50e", "documentation": "

Creates a single-use token that represents a bank account’s details.\nThis token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

", "method": "post", "endpoint": "v1/tokens", "responses": [ { "uuid": "d5b49028-e57a-4094-8ea2-d2a75e30382c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "2d2cc2fb-77bc-49dd-b3d6-19015a6fd95a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa13dc48-fbff-4128-a7f2-bc0016495926", "documentation": "

Retrieves the token with the given ID.

", "method": "get", "endpoint": "v1/tokens/:token", "responses": [ { "uuid": "4d6b6d57-63fb-44e2-9ea1-03d22cdcbccf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "fa37248b-ca88-4523-8f30-f40d8370881b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ada6d44-17c1-470d-9727-8864fe5588c8", "documentation": "

Returns a list of top-ups.

", "method": "get", "endpoint": "v1/topups", "responses": [ { "uuid": "b063e120-25c8-4f05-8b32-450ec0848051", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b17b05d0-9b04-4957-a798-42e06e090fdf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fbebbac8-1111-44b2-a94e-cdd12683da70", "documentation": "

Top up the balance of an account

", "method": "post", "endpoint": "v1/topups", "responses": [ { "uuid": "2c6a8e7f-933c-4314-93d0-e3db6ad8f989", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "f1f619e5-0873-45e4-8ba0-780ae82cc8c6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f001c9f6-ba1d-4338-9a4c-c19d0f971f9c", "documentation": "

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

", "method": "get", "endpoint": "v1/topups/:topup", "responses": [ { "uuid": "8897ec26-7b64-400c-83a9-9ac5c491ba6f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "1abad845-e07e-42a7-9b75-9bb805957741", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cd3bb85a-7692-41aa-9ccf-bebdf53e6e8b", "documentation": "

Updates the metadata of a top-up. Other top-up details are not editable by design.

", "method": "post", "endpoint": "v1/topups/:topup", "responses": [ { "uuid": "ecfd86c2-499f-4a71-a8f8-6bfc8c02d697", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b494896c-a4ee-448b-a0f2-0d38dc6407ed", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3159ea0c-6890-42c3-bda4-be5209afd645", "documentation": "

Cancels a top-up. Only pending top-ups can be canceled.

", "method": "post", "endpoint": "v1/topups/:topup/cancel", "responses": [ { "uuid": "79d8474a-5b51-45dc-947d-5fe0ec895de8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "55319e75-3110-4032-945e-97b348209854", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de9ac8f2-94b8-49c6-b540-1593e3c3ba5e", "documentation": "

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

", "method": "get", "endpoint": "v1/transfers", "responses": [ { "uuid": "5c58097e-632d-4bbf-b93e-8ea2803e7b86", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "a791783f-3f61-49af-acff-79bd9fccd3ab", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6ae98498-8911-4251-9db3-9f3c55743120", "documentation": "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

", "method": "post", "endpoint": "v1/transfers", "responses": [ { "uuid": "ebb01f13-545e-4d99-9073-ca1a260b00e4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "ef2f1990-f558-4cb0-a1b7-ddde1f4cb65f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "72efe102-2126-4a1f-82ea-a7e5f4615358", "documentation": "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

", "method": "get", "endpoint": "v1/transfers/:id/reversals", "responses": [ { "uuid": "e90b93d2-a068-461a-be4a-e7f3a60a5d42", "body": "{\n \"data\": [\n \"\"\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "23c7861b-10ca-4b14-b60e-1306ced40654", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5de0256-f3da-4bbd-96d7-78fd42468b7f", "documentation": "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

", "method": "post", "endpoint": "v1/transfers/:id/reversals", "responses": [ { "uuid": "89b07b71-eaeb-4a75-86ea-684e21bd2320", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "4796b263-cb83-41f5-9058-305ec157e176", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bf530b4b-fc03-42cd-ab16-b504a1ade996", "documentation": "

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

", "method": "get", "endpoint": "v1/transfers/:transfer", "responses": [ { "uuid": "27ac2bcb-ada6-44c7-9e94-a230e77c2abc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "bb14006e-348a-44b4-9ff0-ddbf70eac128", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1103ba7a-4b3e-4b3a-9f53-bd1937ae6c39", "documentation": "

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts only metadata as an argument.

", "method": "post", "endpoint": "v1/transfers/:transfer", "responses": [ { "uuid": "cc8876d6-ea35-4df6-950a-a97603f81f00", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "3806aea9-9a8d-43ee-84a1-4d13add3d2cc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d7a14f3-80e2-4306-bf09-623764bab5cc", "documentation": "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

", "method": "get", "endpoint": "v1/transfers/:transfer/reversals/:id", "responses": [ { "uuid": "5df0c199-e6cb-48d8-964a-c7d0a2a2a0a6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "18f34ee1-7a12-4175-a9dd-ed9fcb974ce5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2bbf60f0-0694-4a6f-8eab-a5a5d5b72c36", "documentation": "

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata and description as arguments.

", "method": "post", "endpoint": "v1/transfers/:transfer/reversals/:id", "responses": [ { "uuid": "1fffa4a0-f729-45a6-b877-d370d2a0926e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "cb999b33-38c9-4194-b5be-761fe01b1352", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0049abf5-35b9-47c7-8755-ea6673fb3bb1", "documentation": "

Returns a list of your webhook endpoints.

", "method": "get", "endpoint": "v1/webhook_endpoints", "responses": [ { "uuid": "87e7a6b1-7e29-4d5e-bc29-6a6ee2eec313", "body": "{\n \"data\": [\n {\n \"api_version\": \"\",\n \"application\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"enabled_events\": [\n \"\"\n ],\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'webhook_endpoint')}}\",\n \"secret\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n }\n ],\n \"has_more\": {{faker 'datatype.boolean'}},\n \"object\": \"{{oneOf (array 'list')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b8202e19-83f3-4667-ae2f-f78738cfd1fb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1cdf231d-a5f1-40fb-9e2c-f6b162fc3276", "documentation": "

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

", "method": "post", "endpoint": "v1/webhook_endpoints", "responses": [ { "uuid": "c5d4a149-2267-4bbb-b1fc-1b581cc79fe6", "body": "{\n \"api_version\": \"\",\n \"application\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"enabled_events\": [\n \"\"\n ],\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'webhook_endpoint')}}\",\n \"secret\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "72226a16-d7d4-410a-9dde-e4685ef65f84", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2ac7e37-5833-49b7-b072-03f590eb7efb", "documentation": "

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

", "method": "delete", "endpoint": "v1/webhook_endpoints/:webhook_endpoint", "responses": [ { "uuid": "4ac7f4e2-abb0-4575-ada6-24e3417139f7", "body": "{\n \"deleted\": \"{{oneOf (array 'true')}}\",\n \"id\": \"\",\n \"object\": \"{{oneOf (array 'webhook_endpoint')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "e64ba072-37fb-47fa-9159-65de54a85480", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9afe8018-fdd6-4755-947c-669a19000a21", "documentation": "

Retrieves the webhook endpoint with the given ID.

", "method": "get", "endpoint": "v1/webhook_endpoints/:webhook_endpoint", "responses": [ { "uuid": "7d3645c4-34f1-4cae-bc11-75920926573f", "body": "{\n \"api_version\": \"\",\n \"application\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"enabled_events\": [\n \"\"\n ],\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'webhook_endpoint')}}\",\n \"secret\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "b1a49b55-ac53-4565-a9cd-99fc4ad21c1d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "920c050d-c727-4be3-8621-7df5cc44eb19", "documentation": "

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

", "method": "post", "endpoint": "v1/webhook_endpoints/:webhook_endpoint", "responses": [ { "uuid": "e4e47260-6014-4c21-9e44-350e9b9cc53f", "body": "{\n \"api_version\": \"\",\n \"application\": \"\",\n \"created\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"enabled_events\": [\n \"\"\n ],\n \"id\": \"\",\n \"livemode\": {{faker 'datatype.boolean'}},\n \"metadata\": {},\n \"object\": \"{{oneOf (array 'webhook_endpoint')}}\",\n \"secret\": \"\",\n \"status\": \"\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" }, { "uuid": "edced010-77b0-4c70-ae74-a32f50d03b90", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "databucketID": "", "bodyType": "INLINE", "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "5679cb22-3d0c-4589-b16f-e73234fa72ce" }, { "type": "route", "uuid": "008df469-c5fe-4c55-9c3d-90b930ccf7ae" }, { "type": "route", "uuid": "3eb313f1-dd45-4292-be5e-a07c7be34a01" }, { "type": "route", "uuid": "7610f787-1faa-49be-88ca-34138937daa4" }, { "type": "route", "uuid": "872701e6-99e6-4cfc-9033-dec688c79052" }, { "type": "route", "uuid": "607c34ff-39dc-407e-8ed6-544510ed3342" }, { "type": "route", "uuid": "1272a404-4989-4135-910d-d2e605eff561" }, { "type": "route", "uuid": "b8e8fb5f-33ed-4f94-871e-15f7baf4b301" }, { "type": "route", "uuid": "2924dcb8-7b7e-4ed9-b074-68f42116fcf8" }, { "type": "route", "uuid": "ba21a72c-f225-40e6-97bc-1363e3556c0d" }, { "type": "route", "uuid": "f4c96581-3893-40c8-80bf-0b78257e5841" }, { "type": "route", "uuid": "0fd3ca9c-45ea-40a7-bcd5-a1c6a4b44233" }, { "type": "route", "uuid": "683d6fd2-41bd-45c4-a322-14d7206a437d" }, { "type": "route", "uuid": "33506794-d45d-4303-ac2e-684d4c033485" }, { "type": "route", "uuid": "b15e9954-59f5-4399-87d2-5bd3dd64e47a" }, { "type": "route", "uuid": "43f7fccc-9085-4528-ae86-0078452ad509" }, { "type": "route", "uuid": "9d81569f-697e-4b01-a085-45b718adb2e8" }, { "type": "route", "uuid": "7ff6091f-5681-40e9-96d1-a14dc19b276d" }, { "type": "route", "uuid": "52c2198e-912e-40b8-9569-3670713d4226" }, { "type": "route", "uuid": "e33a79d7-d3fb-477d-a0a8-4a66ef56176b" }, { "type": "route", "uuid": "e0dff2ee-4de1-4734-b3b6-3f7e02d7fcce" }, { "type": "route", "uuid": "dba424dc-966a-48d4-80b6-3ee8dfdde18e" }, { "type": "route", "uuid": "5141c9a5-ecf2-4056-a19a-4ca01f102a84" }, { "type": "route", "uuid": "00894be2-8d76-4dfe-8287-25e5eced9719" }, { "type": "route", "uuid": "f1521d13-bf9b-4aca-802e-619baffe22ed" }, { "type": "route", "uuid": "3d1abdf5-f82b-4009-9f82-ef4a4e6635af" }, { "type": "route", "uuid": "9aa9fad8-932c-474d-b9f1-57f4ac895db0" }, { "type": "route", "uuid": "9e06b910-da7b-4c14-a2d9-45ce214abc44" }, { "type": "route", "uuid": "21ac32af-e25a-4d96-8ac1-f3e3b69b008b" }, { "type": "route", "uuid": "a9b21498-31bb-4171-bba2-5cad78c3daae" }, { "type": "route", "uuid": "24f5762a-1d46-46f2-b655-daa749e167df" }, { "type": "route", "uuid": "44b2fa78-11b4-4a2a-b729-c3370e3b961a" }, { "type": "route", "uuid": "a0f36cd7-5069-4dde-ae94-fe01597d3717" }, { "type": "route", "uuid": "79d165ec-bbf0-4abd-b4fc-33d314fdab5c" }, { "type": "route", "uuid": "e8531537-ce30-433d-8afa-460ceed17cf8" }, { "type": "route", "uuid": "e96b63b3-aa84-4e50-8931-59b223fa5568" }, { "type": "route", "uuid": "ca7ebbd5-1c97-431f-ae57-6eed26b4dbc4" }, { "type": "route", "uuid": "19ecb2a6-5e08-4b2b-a99b-ff6b93e9d81b" }, { "type": "route", "uuid": "b02f235c-3569-47ff-8fa5-db295b897bc4" }, { "type": "route", "uuid": "dfd66cd0-92e5-49db-94d1-05a3b77bace8" }, { "type": "route", "uuid": "72147ef3-dfca-4c46-9368-b0ea958964c0" }, { "type": "route", "uuid": "f506eb31-4354-4cee-9a99-db118b54927b" }, { "type": "route", "uuid": "f65c96cd-4da5-4141-ac72-7773307872f4" }, { "type": "route", "uuid": "485011be-cad8-4aa0-93eb-b9b7339384f0" }, { "type": "route", "uuid": "417087e2-71d4-4d8a-bfde-20186d6112c2" }, { "type": "route", "uuid": "5124662c-cf8b-4dc4-b00d-327170112bd3" }, { "type": "route", "uuid": "2673c980-60e1-49d6-b8f2-31750e8e4ae6" }, { "type": "route", "uuid": "bedfbd84-4aca-455a-88e2-f8ff63a6119f" }, { "type": "route", "uuid": "6d5a789c-5285-4b9b-8be2-88a6480f8e48" }, { "type": "route", "uuid": "6ee97f4f-7260-4117-b6ab-3f2f9622f808" }, { "type": "route", "uuid": "1850bb99-2fd6-41f1-b7f8-032dacd7b57f" }, { "type": "route", "uuid": "053d7d01-d47e-44e2-a8fa-d3652c08caff" }, { "type": "route", "uuid": "c45e1c55-f147-412e-b3a6-80d5bf839b98" }, { "type": "route", "uuid": "401f3189-17cb-4724-8c49-4ae03708f78d" }, { "type": "route", "uuid": "c2b26f0b-7ffc-48fe-bbbe-29840b1d3aa6" }, { "type": "route", "uuid": "d45bcf67-b2ea-4b6d-a670-0d572bb636ff" }, { "type": "route", "uuid": "13a35bcd-ac00-4469-89fe-a2ec8b1f8925" }, { "type": "route", "uuid": "925c554d-8a7b-492a-8213-4b6ece4f13ca" }, { "type": "route", "uuid": "f9efba97-f1e3-4426-ba53-2ae93184965c" }, { "type": "route", "uuid": "ac701c86-4552-4c76-a849-1c261dbd60bf" }, { "type": "route", "uuid": "150a78b4-fa55-491c-bf80-a6b70bdbae47" }, { "type": "route", "uuid": "db81636e-7b25-4d4f-af0b-62a84c70b532" }, { "type": "route", "uuid": "2f29adb2-3c5f-4afc-b2ba-ee3aa8960e9a" }, { "type": "route", "uuid": "aa3203a6-34c4-4690-8cec-b6c66e3699c0" }, { "type": "route", "uuid": "d7a15a69-083f-41d6-9ee5-87021c866f58" }, { "type": "route", "uuid": "878386d7-5d2a-439c-8f5d-53fac8d469e9" }, { "type": "route", "uuid": "14afded1-4804-483e-8def-95d1ac3c761d" }, { "type": "route", "uuid": "13fc2b2c-5267-4d6d-9c3f-b3c614bcd339" }, { "type": "route", "uuid": "757bdea4-291d-4f84-bf23-de1ed295daf0" }, { "type": "route", "uuid": "bc3b48c0-75d7-4fa3-9819-3fede6447b37" }, { "type": "route", "uuid": "3f8667f0-f17a-4ba3-b940-9f2cc0c82e67" }, { "type": "route", "uuid": "ea9f2093-a5d4-41ea-b1ed-fdc233c57df6" }, { "type": "route", "uuid": "1b9d551c-17cb-471c-b278-ac43b3cf3b43" }, { "type": "route", "uuid": "bce5800c-2aeb-4b72-9fa8-fa5d74000b8f" }, { "type": "route", "uuid": "dba5034c-38a8-4d8e-88d5-a3d2946c874e" }, { "type": "route", "uuid": "7e5f021b-9386-4843-9b28-364c5423236c" }, { "type": "route", "uuid": "140732b3-d4c7-41c6-82ea-58ae2095459c" }, { "type": "route", "uuid": "0b9a27d1-3f06-449c-a4a6-386e089386cd" }, { "type": "route", "uuid": "537f9358-15bf-4a6f-8ffa-a5023e5f68b7" }, { "type": "route", "uuid": "ac2637a7-0f7b-4a8f-ba5c-56e704ad46e0" }, { "type": "route", "uuid": "d05cb568-2c5f-4941-96f2-b92f0596cb9e" }, { "type": "route", "uuid": "6a8ea13a-1787-4076-86df-8bc357e554df" }, { "type": "route", "uuid": "8ac8d034-a623-4dc9-9be4-7a1930997289" }, { "type": "route", "uuid": "c6f00eb9-ca9f-4e67-b36f-22fc36540796" }, { "type": "route", "uuid": "d2f03af7-7c2a-475f-b307-454de7d9ec63" }, { "type": "route", "uuid": "4d037731-ee04-4521-8929-2102de35c766" }, { "type": "route", "uuid": "3a285b49-188e-49ec-b3d0-ee45d50701f2" }, { "type": "route", "uuid": "d7962aad-ea49-4bcd-9000-99d332111e85" }, { "type": "route", "uuid": "c6328e34-a86e-41e9-b0bf-0d8d0de4173e" }, { "type": "route", "uuid": "9b65257f-c549-47b7-aa28-ad7a37d3fba9" }, { "type": "route", "uuid": "50b908b4-39a6-4240-809d-97670bd8cd54" }, { "type": "route", "uuid": "852cee6a-3268-40ae-b075-083bb3895655" }, { "type": "route", "uuid": "e48eed28-2185-4670-8715-df8b06be5ae3" }, { "type": "route", "uuid": "97abdacc-5b3d-4f16-bf3e-33a5e18ada00" }, { "type": "route", "uuid": "2050b5f7-e7f5-4084-ab50-bb2950d8a531" }, { "type": "route", "uuid": "80ffe69c-016e-4b44-85fa-b842a8621a67" }, { "type": "route", "uuid": "034368db-d17e-40ab-9003-27cee3bb61e2" }, { "type": "route", "uuid": "1f03de91-881e-4bb4-95ae-8f99bd46aa2b" }, { "type": "route", "uuid": "e7547f19-c066-435c-96a1-cdd3c239fd0f" }, { "type": "route", "uuid": "ab9278bd-35ed-4a9e-8527-0f17363f1732" }, { "type": "route", "uuid": "0f36bd4d-dafc-4e45-9132-65bac6e729af" }, { "type": "route", "uuid": "64ba04a5-1d3c-4d58-abe9-d5a70d46ec42" }, { "type": "route", "uuid": "cf99431e-e2b8-4c26-aec1-a8b2719945c8" }, { "type": "route", "uuid": "04f24aff-06ed-4e7c-bc6b-89abd57c0a38" }, { "type": "route", "uuid": "d384f356-0d2d-4687-9427-2a54634aae8e" }, { "type": "route", "uuid": "4c6f6757-8131-4ca1-9330-3a74b057d92e" }, { "type": "route", "uuid": "48cac8ad-d612-4da4-92fc-31d4e5fba7f3" }, { "type": "route", "uuid": "ae9395fe-c4dc-44db-bfc0-81692f9e6793" }, { "type": "route", "uuid": "451cf404-df8e-467f-94d9-e83a276e8083" }, { "type": "route", "uuid": "2fb4f58c-31fb-483a-97d0-c4551f354fe7" }, { "type": "route", "uuid": "a989e8d1-f050-4c63-b302-ff466b63599f" }, { "type": "route", "uuid": "11373ff6-df7e-4e30-97d0-742225c05793" }, { "type": "route", "uuid": "8f526133-c4a2-4957-92c8-5ece74fcbc56" }, { "type": "route", "uuid": "34eece1c-3a28-434f-a301-840f77c1b240" }, { "type": "route", "uuid": "84662484-58a0-439a-98b6-60e3f0f63b2d" }, { "type": "route", "uuid": "2e56c8ee-a720-4100-81c3-8bc8d66ab411" }, { "type": "route", "uuid": "d7e19067-159f-4751-a9e5-dc61a70b23ae" }, { "type": "route", "uuid": "1a454b07-bd4b-41dc-ba78-773586c14d77" }, { "type": "route", "uuid": "bd23a4bc-9a30-4eab-b8b3-fe989242ceac" }, { "type": "route", "uuid": "5a042872-0c89-468a-b316-c63c73c5e513" }, { "type": "route", "uuid": "d4fb5c81-4e63-4830-b927-5764a2a3bcea" }, { "type": "route", "uuid": "38da2000-d516-4b5d-bd33-4e2764ddf43d" }, { "type": "route", "uuid": "329128e9-69e5-480b-aced-ac24e162257e" }, { "type": "route", "uuid": "eeeb5eb0-acb8-4da5-b367-3bb712f08db5" }, { "type": "route", "uuid": "b6a622cc-b087-4514-aeb5-7cb96e81f261" }, { "type": "route", "uuid": "e7fccd07-d1c0-482a-81c9-3263fe17f4df" }, { "type": "route", "uuid": "64e9ce6f-ca65-41ee-91e5-d9bc97cdf825" }, { "type": "route", "uuid": "b83ebc69-9e92-4a06-8016-2dc4cb8affa3" }, { "type": "route", "uuid": "5b8ae5be-e7c6-4f12-8621-3ffc9de41636" }, { "type": "route", "uuid": "383a52dc-7e55-469a-a3f2-1a18bb81ce87" }, { "type": "route", "uuid": "00eb42c5-51db-42cd-b71c-8cc3ba62228f" }, { "type": "route", "uuid": "3ddf7eb0-5398-46a5-b207-1691830790f4" }, { "type": "route", "uuid": "99ec6173-3ce3-4f2a-8377-05f5ad04c8f2" }, { "type": "route", "uuid": "82ed05db-3c8f-4ab6-99c4-a0e619630e14" }, { "type": "route", "uuid": "2209e8e3-6640-46eb-ab5c-5fe9831d44b8" }, { "type": "route", "uuid": "b7d617ed-04f6-45b2-a43d-31ac70d3b664" }, { "type": "route", "uuid": "9cea2922-dd89-4001-8bf3-6663d512b5d6" }, { "type": "route", "uuid": "aac3fde5-867e-4a59-a494-a149cacac25f" }, { "type": "route", "uuid": "8f4cf246-956f-4374-849c-be881e391b00" }, { "type": "route", "uuid": "207e99e0-9736-43ee-8371-e2b7e8fdaf31" }, { "type": "route", "uuid": "8466048a-c440-4a32-96a5-549ba3e40cef" }, { "type": "route", "uuid": "5db59a5b-d851-4f54-9938-2256e2c1c972" }, { "type": "route", "uuid": "e1e60bb8-5ae7-4b20-9a15-cbb02970a817" }, { "type": "route", "uuid": "c541e34d-7c13-40ec-9a58-348c90310796" }, { "type": "route", "uuid": "54d8974a-5598-4214-9b8c-188c37f23377" }, { "type": "route", "uuid": "a5080640-d227-4c52-b1cf-02a605200abd" }, { "type": "route", "uuid": "36c1842f-c5cd-4776-b421-20e406888501" }, { "type": "route", "uuid": "a357a075-ae0f-4230-ad7e-887e677c3e7a" }, { "type": "route", "uuid": "f0ee6a1b-8ed2-413c-99aa-26d872d9476d" }, { "type": "route", "uuid": "18c89f98-ec9c-433a-b4c2-39a217a7778f" }, { "type": "route", "uuid": "18747123-fa6c-4ba3-acff-5c30c3d96851" }, { "type": "route", "uuid": "794bddd8-188e-4c5d-a42e-f55345bf187b" }, { "type": "route", "uuid": "1f775f28-9c30-4bcd-a620-952adf7d5597" }, { "type": "route", "uuid": "5297c84c-e1be-4c65-810f-53ee35efe309" }, { "type": "route", "uuid": "e7edcd29-1c24-43f3-b0e2-5e55dcad946f" }, { "type": "route", "uuid": "418cc352-d731-4e67-b5a0-b9f132bb8e54" }, { "type": "route", "uuid": "773cf151-5065-40ad-aa14-9a82f631b250" }, { "type": "route", "uuid": "b802aaa2-ee05-405c-975c-b2299dbc712f" }, { "type": "route", "uuid": "8d6ca44b-ac83-42a1-a668-912cbfdd183b" }, { "type": "route", "uuid": "e4897d39-83aa-4522-9828-cc89b9544ddd" }, { "type": "route", "uuid": "9806f1a0-c7ca-494e-b8ea-a1da8ae6256c" }, { "type": "route", "uuid": "339ce62a-2095-40f8-ae8d-adb00dcc1d33" }, { "type": "route", "uuid": "3ffc4e49-9f5a-471b-beb9-94e4e4f4cbe5" }, { "type": "route", "uuid": "0ebe1692-a110-4402-82f9-7d586683fdc7" }, { "type": "route", "uuid": "7824c62f-234b-49a2-be38-5b5726e20215" }, { "type": "route", "uuid": "3d654296-5f8e-46d1-9417-1b75e33652c2" }, { "type": "route", "uuid": "de380902-6df5-4d0a-bf9e-089f018a9a50" }, { "type": "route", "uuid": "f3dbad27-aa70-4991-bcf4-7df973cb7501" }, { "type": "route", "uuid": "aaf1ea06-ba23-45b5-832c-d73e1343ab35" }, { "type": "route", "uuid": "92796b2e-0824-47be-a86b-087a5be1d48d" }, { "type": "route", "uuid": "3f8e9872-ce84-43f4-ab22-09fc929caa31" }, { "type": "route", "uuid": "032a7eec-eac1-46b3-9377-b4b8b81f0eab" }, { "type": "route", "uuid": "cc112b7c-bb72-40e6-acf9-ee48cb2d69c2" }, { "type": "route", "uuid": "0e9fa498-c695-4101-9056-a45c5bf0cc2b" }, { "type": "route", "uuid": "048fc044-fcf4-4c03-8140-05d0df3f4964" }, { "type": "route", "uuid": "25430189-e4e2-4011-b182-f9fc023ed8be" }, { "type": "route", "uuid": "d1b498f0-c361-4138-ae7e-0433fc87e3ef" }, { "type": "route", "uuid": "48e5dfe7-4f5c-4232-a7ea-c46b5aa1cbf2" }, { "type": "route", "uuid": "4d8a1482-7b48-4083-b20d-d23aff4753fa" }, { "type": "route", "uuid": "39ad2632-c167-4c56-a48b-6ac5b4fa18bd" }, { "type": "route", "uuid": "1184f0b1-254f-4d05-8f8b-b16ba4bccd3f" }, { "type": "route", "uuid": "a2285aa4-9a26-469b-a187-f0e0cdd12871" }, { "type": "route", "uuid": "cb306c89-af4b-428f-bf77-69a77e10369e" }, { "type": "route", "uuid": "036bd77b-e80f-43f3-a891-cff4719794c1" }, { "type": "route", "uuid": "35f99483-db4b-4aba-a3e4-1b0e1e078cea" }, { "type": "route", "uuid": "d9eefa5b-a90a-4355-abbf-396f4d1cfb4f" }, { "type": "route", "uuid": "2e84c7df-56f9-4e8d-a9a7-80488ec03127" }, { "type": "route", "uuid": "a1f6f94d-1ef1-42c0-b007-35ff1c23f456" }, { "type": "route", "uuid": "7c336496-c0e8-42e9-942e-2351202f5056" }, { "type": "route", "uuid": "ec5f1414-0308-4d4e-a561-3e657dc0990e" }, { "type": "route", "uuid": "5414c33a-5ef6-4145-b023-bd57ace8f3d4" }, { "type": "route", "uuid": "b8b0d538-e0aa-48c9-a058-d3e5e29cbc57" }, { "type": "route", "uuid": "b1a9c484-9d3f-4551-8470-f0bd6f0f8776" }, { "type": "route", "uuid": "36da4ced-764e-4ef3-801d-7af5f28f3d4f" }, { "type": "route", "uuid": "2b233cde-2c47-443a-aade-3df1853f434d" }, { "type": "route", "uuid": "8f24da40-a27b-4728-ae34-4747b2f90349" }, { "type": "route", "uuid": "077d61d3-c361-4a52-93b8-8ea86d4c0331" }, { "type": "route", "uuid": "cc7791af-ecee-4a6f-8f6f-3fe79fbb0fd6" }, { "type": "route", "uuid": "c82b285a-d391-4bf7-bf1d-f8415dbdea9d" }, { "type": "route", "uuid": "3f6f5c3d-96c1-4384-9454-380264466796" }, { "type": "route", "uuid": "dc64b271-23be-46ba-8cdd-153a662b0557" }, { "type": "route", "uuid": "680d0e5a-afe6-4fc4-a93d-77b328f9be88" }, { "type": "route", "uuid": "7018d6c7-2549-4054-bc48-94b32f7bbec3" }, { "type": "route", "uuid": "443773f8-a1c6-4171-8e7b-f8f955fee1e4" }, { "type": "route", "uuid": "f07a3ba6-9872-4f40-b178-514c0b7a690e" }, { "type": "route", "uuid": "d8aba35d-f57d-49b6-a797-2b15d70be5bf" }, { "type": "route", "uuid": "4947b145-c42a-42c3-bf94-1b220023b364" }, { "type": "route", "uuid": "9094624a-de30-4144-9ffb-d6a6d2372478" }, { "type": "route", "uuid": "2b236513-df2a-4cc3-ad44-321f2cf2354d" }, { "type": "route", "uuid": "43a2051f-ad77-4788-9107-28f25c12d53c" }, { "type": "route", "uuid": "fa4a47e9-9013-4d97-b2c5-b2770765e7f5" }, { "type": "route", "uuid": "51013968-5cda-4bf8-bace-ee0cb2001ba1" }, { "type": "route", "uuid": "9937e0e2-0172-4f1b-af41-1eabe549930a" }, { "type": "route", "uuid": "db49f85d-8ea3-4ce8-a33e-00a027a1f2e5" }, { "type": "route", "uuid": "c1cddf1e-a78a-4a1e-8ac4-2fa5678fc5e6" }, { "type": "route", "uuid": "1b41365e-7005-416a-a832-b1460f78a938" }, { "type": "route", "uuid": "7ad34f67-dd14-4c79-8eb1-ac934031f4e8" }, { "type": "route", "uuid": "80e59027-96fc-4c7e-a218-c6a698d3b675" }, { "type": "route", "uuid": "341d231f-8960-41ca-ac6a-aafcac3aa699" }, { "type": "route", "uuid": "de743f7e-073d-45b5-9d51-e66a488de374" }, { "type": "route", "uuid": "d06a75c3-9c1a-488e-87e0-1413d00630e0" }, { "type": "route", "uuid": "c296ef0e-5cd4-4a17-b144-2b0fe8823412" }, { "type": "route", "uuid": "274ec179-5bfc-4705-9b99-aabc9b728f8a" }, { "type": "route", "uuid": "3ed1d5ca-1fd7-4d3d-b0f9-24b38a6f8ab6" }, { "type": "route", "uuid": "31b39e9a-c304-4963-9334-d06adce9b9ca" }, { "type": "route", "uuid": "dd4dba4d-01cc-4f55-8e8c-0dad974867d7" }, { "type": "route", "uuid": "10a90d76-7dab-411f-bc99-4a5c9c6dd2af" }, { "type": "route", "uuid": "63fc84ed-9ef6-41fb-8072-9a65894093ee" }, { "type": "route", "uuid": "eb60922c-69cd-4a68-9cd8-c9d0e3d8bb4c" }, { "type": "route", "uuid": "ac1fe2f3-4207-42cf-8557-ac9cdb89045a" }, { "type": "route", "uuid": "c1c97c95-585a-4516-a81b-d86003492186" }, { "type": "route", "uuid": "d9cb0298-470b-4079-a8af-48ecb4a23f5e" }, { "type": "route", "uuid": "d94dfcd3-8af2-4a5d-a4f3-8dd61338b3f5" }, { "type": "route", "uuid": "72497e8a-c33c-4ad5-8124-f9d9b2bd4e38" }, { "type": "route", "uuid": "ce04c995-0152-45b4-87cf-842b575ae622" }, { "type": "route", "uuid": "4725a046-c913-4df3-895e-38c9165fba1d" }, { "type": "route", "uuid": "ce14e15e-eff4-43b9-aa3d-bd94b8343870" }, { "type": "route", "uuid": "6899f14b-65bf-4802-9366-d0d0c4900287" }, { "type": "route", "uuid": "a8ee84cc-9f17-4912-ab16-5055260a970c" }, { "type": "route", "uuid": "3142fb57-da80-41ef-8c81-c753c73fca18" }, { "type": "route", "uuid": "272a1be1-d289-4bce-9e75-c7b52cadc804" }, { "type": "route", "uuid": "0fd64cad-41bd-410d-bac3-045c1da89fec" }, { "type": "route", "uuid": "9fab37e3-8d2f-4180-a6a5-b7985696ba58" }, { "type": "route", "uuid": "96ead1f2-8291-4706-9eae-13055d346b4f" }, { "type": "route", "uuid": "e3bb772d-118e-419c-b853-e8abc99e6853" }, { "type": "route", "uuid": "20cba284-30de-469d-bc55-aa1b8b2ec10b" }, { "type": "route", "uuid": "21683dbf-d815-4444-b075-e705965c281e" }, { "type": "route", "uuid": "120dde12-1c99-4786-9a76-b551e339a1a0" }, { "type": "route", "uuid": "5027c751-d966-4416-bf57-98769c50b4f5" }, { "type": "route", "uuid": "33c7b446-9222-4a2c-8e64-ea5e7cd16a15" }, { "type": "route", "uuid": "109c6630-84f6-4a05-9db4-4036b2d70c3f" }, { "type": "route", "uuid": "a90ca23c-f80f-4e73-af5e-052d82ac889b" }, { "type": "route", "uuid": "bcde1f16-fe84-4ab6-88df-cb1e59b35679" }, { "type": "route", "uuid": "a236a144-2eff-48af-9638-3479329d4806" }, { "type": "route", "uuid": "95a83497-d2f4-42f4-abbc-ecfd4b9d9db2" }, { "type": "route", "uuid": "4848645f-c342-458d-a43e-c979891b92ae" }, { "type": "route", "uuid": "f975f8e4-89be-478d-aa08-4acf0f4a4da4" }, { "type": "route", "uuid": "28f31d47-2b56-4eeb-b2e0-e0b9c655cfbb" }, { "type": "route", "uuid": "6fc4bfc5-ca53-4b4a-b083-30e21877d395" }, { "type": "route", "uuid": "0b831ff1-1680-4fa8-a637-af47a00603b5" }, { "type": "route", "uuid": "14f3f171-51a1-4e5e-a5eb-86520536d642" }, { "type": "route", "uuid": "a6d3f66c-349c-45d6-8f8e-0b361347234e" }, { "type": "route", "uuid": "dfd12e16-ba1b-4881-b5f7-5d8499b204f8" }, { "type": "route", "uuid": "d9612d27-94c0-4b15-bb32-0b0e8c0a8f3b" }, { "type": "route", "uuid": "7299608a-5712-4fa3-bd89-6f85ac98c5b4" }, { "type": "route", "uuid": "4bb320fc-f409-49b9-997a-245b333399d8" }, { "type": "route", "uuid": "d7c39a18-74bf-41e8-b5eb-ffb732907658" }, { "type": "route", "uuid": "d7d0ea83-972a-461d-a66b-18eb6e349e7c" }, { "type": "route", "uuid": "356427c2-b051-41bd-8f2b-729bca7e0654" }, { "type": "route", "uuid": "4c759127-5ad6-41ea-ab10-092a17d97ec9" }, { "type": "route", "uuid": "fadfe152-d494-4672-b805-15adbfd34266" }, { "type": "route", "uuid": "473cb41b-7dba-477b-a27f-80a8d65b1e5f" }, { "type": "route", "uuid": "ba2ee24a-35b1-411a-8258-a366bab8956d" }, { "type": "route", "uuid": "1134ee1d-c887-458b-84c7-e30dbbe111a6" }, { "type": "route", "uuid": "b478add0-becd-41f6-bcd6-1722092afe19" }, { "type": "route", "uuid": "9f44f0f1-07bb-4949-ae3b-85e97d8a8236" }, { "type": "route", "uuid": "4fcaebd9-ccad-494d-b4a0-db2bdef3fbec" }, { "type": "route", "uuid": "5c783c8a-6434-4360-9dcc-574cf664075c" }, { "type": "route", "uuid": "e4997630-af69-48d7-8521-d54f142d796f" }, { "type": "route", "uuid": "c0cef257-f6b1-48c3-ab99-8bf86cf82969" }, { "type": "route", "uuid": "8392e005-3467-4d0b-9383-b4ceef786425" }, { "type": "route", "uuid": "cecaa58d-b5c4-46ab-ab14-392bde744b2c" }, { "type": "route", "uuid": "322c7daf-c48a-4f2d-be51-9a5636d1d706" }, { "type": "route", "uuid": "a8ad6137-5266-422e-9ea5-ce1ce8076820" }, { "type": "route", "uuid": "fa089fc2-0cdf-4b84-9935-9c780daf6cbb" }, { "type": "route", "uuid": "8afb0e01-f0e2-4635-815c-97ac29048ce5" }, { "type": "route", "uuid": "70c31da0-ef19-4eb7-87a7-00d1ad540b05" }, { "type": "route", "uuid": "cfb96704-b6f3-4a40-9153-f7bffa1c8496" }, { "type": "route", "uuid": "2a7123ea-9498-4dd6-bf77-de82dac041dd" }, { "type": "route", "uuid": "7719a0da-0105-4091-b0d0-e3339551bc2d" }, { "type": "route", "uuid": "9355c683-d43d-4fab-a811-a326c15a7c27" }, { "type": "route", "uuid": "a26dcdd7-b01f-4afe-ba94-0a8099670ee8" }, { "type": "route", "uuid": "c909bbf5-dd6f-418c-9201-7093031f52c1" }, { "type": "route", "uuid": "aed7bbb2-67a9-4163-86c8-06d4f6f7725b" }, { "type": "route", "uuid": "3c2e0376-d444-46d8-b1b0-1ada170965ef" }, { "type": "route", "uuid": "dbcdc4d0-94ee-490a-93c7-72f58cb55db7" }, { "type": "route", "uuid": "77c3797d-e03d-4c28-b730-de9be189acb5" }, { "type": "route", "uuid": "84829971-1148-4c66-8a09-efc098740505" }, { "type": "route", "uuid": "621aa2f2-b2fb-4965-90d0-81d1dba528eb" }, { "type": "route", "uuid": "a285ab64-2844-497c-9e63-fabc3e372f69" }, { "type": "route", "uuid": "28a2eb05-27fd-4b15-994f-0fe4cbaa7fa3" }, { "type": "route", "uuid": "777de368-7a8e-494a-ad82-f461f98a9816" }, { "type": "route", "uuid": "14f2c00b-2239-4ffe-9b55-11b673f217e6" }, { "type": "route", "uuid": "b77bc810-4109-4bdd-8b2f-42ff696db0fd" }, { "type": "route", "uuid": "206ba61f-8dde-4ef9-81e7-6a50aebdd8a0" }, { "type": "route", "uuid": "c06713f3-4dcc-479b-9229-aa9a50ad6115" }, { "type": "route", "uuid": "2158ba2e-d8f1-49c3-8c4c-ab8942ec9b0f" }, { "type": "route", "uuid": "e4d57264-c469-4e6b-a62a-6dce378d1865" }, { "type": "route", "uuid": "626bb1ef-e873-4279-9e2d-d84499d13f28" }, { "type": "route", "uuid": "0d858cee-b535-4680-a5e3-323a606915d2" }, { "type": "route", "uuid": "2eb4bca6-d97a-44e6-972f-bd6f5b9d873b" }, { "type": "route", "uuid": "119d606f-aa0f-455c-b275-dd1b9039c1a3" }, { "type": "route", "uuid": "c2321f04-5712-467b-a58a-267040be0e05" }, { "type": "route", "uuid": "2c55d958-fff6-490f-bb81-f16fcff80447" }, { "type": "route", "uuid": "1da12035-5259-422a-ba0b-c6f0ff2f9c9b" }, { "type": "route", "uuid": "bc6ded5e-8cb9-46f4-92b2-4cfc8a0862c2" }, { "type": "route", "uuid": "67e8df17-0c88-427e-95ed-1bfa96fe332c" }, { "type": "route", "uuid": "8de4892f-28eb-440d-98cc-99f8c9147c1c" }, { "type": "route", "uuid": "0160ae3e-6c66-4125-a305-0ed926fff0de" }, { "type": "route", "uuid": "87cb482d-ffd3-40c3-97f3-28ddff460839" }, { "type": "route", "uuid": "ee84c6b1-8c11-4aa4-b467-5b2d084079f7" }, { "type": "route", "uuid": "1f57ce62-90b4-465b-8876-1e4fe947d818" }, { "type": "route", "uuid": "e10a1d2a-a360-4cf1-abbb-04bd0096532a" }, { "type": "route", "uuid": "52b3088b-5965-4158-a27f-242f6e5a2f83" }, { "type": "route", "uuid": "0e06fb64-e304-4bc9-9a0e-abef244ad3b2" }, { "type": "route", "uuid": "173f79bd-2abe-4c70-8c38-586cc358f243" }, { "type": "route", "uuid": "7ce522ef-f604-4444-aaff-9fb0f66f1d88" }, { "type": "route", "uuid": "79020716-aaff-434f-b465-a75f288f779a" }, { "type": "route", "uuid": "fb84a92e-e24e-46fd-8f2a-b4c7696d1954" }, { "type": "route", "uuid": "f64baaa1-fa97-4164-8e7c-9cad6f3cc6c9" }, { "type": "route", "uuid": "f0dfbda9-63bf-477b-8f33-5a5dbc83e707" }, { "type": "route", "uuid": "a75627af-108f-438c-a02d-7ea7e4f425bc" }, { "type": "route", "uuid": "cb748f3b-1c29-4cd3-90f6-eff76c126058" }, { "type": "route", "uuid": "98356568-43b7-4714-931a-cc2ef9009805" }, { "type": "route", "uuid": "7d7871dc-a08e-4e9f-8414-cfdc63e4ae1d" }, { "type": "route", "uuid": "ed4b6f59-d7c7-49e3-90f7-bdf0c8e51b4c" }, { "type": "route", "uuid": "3e012542-594c-477f-be85-bc3f487d9e36" }, { "type": "route", "uuid": "c8b930fb-056d-4e3e-97c3-522f6ea51018" }, { "type": "route", "uuid": "29ebd7a2-ae4f-48f5-9397-a3ba4624ede2" }, { "type": "route", "uuid": "f904ab12-f9d1-431d-a435-46c3a135db27" }, { "type": "route", "uuid": "74632657-68a1-4d20-88e0-cc92a86960d3" }, { "type": "route", "uuid": "ed49b7c7-41c8-454d-9052-867d0b65f242" }, { "type": "route", "uuid": "8dec3831-820f-4b00-b25e-df440830ca75" }, { "type": "route", "uuid": "8487cfb5-bf4b-4827-8cec-895d7c9e2872" }, { "type": "route", "uuid": "7cac2a91-615f-4454-904a-d1735ff8d4d2" }, { "type": "route", "uuid": "e2e4c707-f50d-444a-9e0a-664a2bfdbfed" }, { "type": "route", "uuid": "fe3dc5b5-dbeb-4348-b2fc-ee3bbaad1342" }, { "type": "route", "uuid": "9c60acf9-8919-4bea-9ebc-b1b7183178d2" }, { "type": "route", "uuid": "7088259e-13d3-4dae-b619-69660226e43c" }, { "type": "route", "uuid": "1832e85e-fd1a-4c15-a71d-f160f35e6df7" }, { "type": "route", "uuid": "41bab879-059f-4ba0-a0df-b975bd813fd7" }, { "type": "route", "uuid": "3a79f413-9a6d-4275-9bb0-339542e0f2d9" }, { "type": "route", "uuid": "ff1e0e0e-4179-49e5-9475-07f71cffcd3a" }, { "type": "route", "uuid": "608f752d-4c9d-46e5-b115-9c1a60973867" }, { "type": "route", "uuid": "d693dc34-31e4-4719-8aaa-ab715431739e" }, { "type": "route", "uuid": "d06d434b-9e39-452a-ae29-10c7f663b593" }, { "type": "route", "uuid": "ede83e54-5328-4337-a595-97f0c6833434" }, { "type": "route", "uuid": "0b851aa1-4701-4848-aef9-38ae85685023" }, { "type": "route", "uuid": "c60e38da-7a81-4755-87ec-7d779e5796c0" }, { "type": "route", "uuid": "200cf649-71cb-44e2-8cf3-5c6ab3aebd0b" }, { "type": "route", "uuid": "b6be72cb-8100-4bd3-ab74-0f59b2d28d69" }, { "type": "route", "uuid": "fa371b66-9b86-4a0f-ae43-029647759d96" }, { "type": "route", "uuid": "2aab6859-a9ee-4af1-8691-70df228104f0" }, { "type": "route", "uuid": "e03e8ca7-3ff5-40ff-883c-9799f55e05a1" }, { "type": "route", "uuid": "7c51662a-3f63-420a-8de9-b046f5a1e50e" }, { "type": "route", "uuid": "fa13dc48-fbff-4128-a7f2-bc0016495926" }, { "type": "route", "uuid": "1ada6d44-17c1-470d-9727-8864fe5588c8" }, { "type": "route", "uuid": "fbebbac8-1111-44b2-a94e-cdd12683da70" }, { "type": "route", "uuid": "f001c9f6-ba1d-4338-9a4c-c19d0f971f9c" }, { "type": "route", "uuid": "cd3bb85a-7692-41aa-9ccf-bebdf53e6e8b" }, { "type": "route", "uuid": "3159ea0c-6890-42c3-bda4-be5209afd645" }, { "type": "route", "uuid": "de9ac8f2-94b8-49c6-b540-1593e3c3ba5e" }, { "type": "route", "uuid": "6ae98498-8911-4251-9db3-9f3c55743120" }, { "type": "route", "uuid": "72efe102-2126-4a1f-82ea-a7e5f4615358" }, { "type": "route", "uuid": "d5de0256-f3da-4bbd-96d7-78fd42468b7f" }, { "type": "route", "uuid": "bf530b4b-fc03-42cd-ab16-b504a1ade996" }, { "type": "route", "uuid": "1103ba7a-4b3e-4b3a-9f53-bd1937ae6c39" }, { "type": "route", "uuid": "0d7a14f3-80e2-4306-bf09-623764bab5cc" }, { "type": "route", "uuid": "2bbf60f0-0694-4a6f-8eab-a5a5d5b72c36" }, { "type": "route", "uuid": "0049abf5-35b9-47c7-8755-ea6673fb3bb1" }, { "type": "route", "uuid": "1cdf231d-a5f1-40fb-9e2c-f6b162fc3276" }, { "type": "route", "uuid": "d2ac7e37-5833-49b7-b072-03f590eb7efb" }, { "type": "route", "uuid": "9afe8018-fdd6-4755-947c-669a19000a21" }, { "type": "route", "uuid": "920c050d-c727-4be3-8621-7df5cc44eb19" } ] }