--- title: List payment provider settings slug: reference/list-payment-provider-settings docTags: createdAt: 2025-08-21T21:09:26.155Z --- { "id": "jcYOu3wgKezXLCl8VAIKy", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/billing-settings/list", "servers": [ { "url": "https://app.amberflo.io/payments/billing-settings/list" } ], "name": "List payment provider settings", "description": "

Retrieves all configured payment provider settings for your account.\nUse this endpoint to discover available payment methods and obtain targetPaymentId values for payment switching operations.

\n

Use this endpoint to:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Returns array of all payment provider settings configured for the account", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Account payment method configuration containing credentials and settings for integrating with payment providers like Stripe and AWS Marketplace.", "customType": "payment.payment.AccountPaymentSetting.out[]", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "description": "Unique identifier of the account that owns this payment method configuration", "example": "" }, { "name": "billingSystem", "kind": "optional", "type": "string", "description": "Type of payment provider system such as Stripe, AWS Marketplace, or Azure Marketplace", "modelRef": "#/components/schemas/customer.payment_method.BillingSystem.in", "customType": "customer.payment_method.BillingSystem.in", "schema": [] }, { "name": "gracePeriod", "kind": "optional", "type": "integer", "description": "Number of hours to wait before marking an unpaid invoice as overdue", "example": 0 }, { "name": "sendPaymentAutomatically", "kind": "optional", "type": "boolean", "description": "Whether to automatically charge customers when invoices are generated", "example": "" }, { "name": "emailInvoiceToCustomer", "kind": "optional", "type": "boolean", "description": "Whether to automatically send invoice emails to customers when generated", "example": "" }, { "name": "paymentAccountId", "kind": "optional", "type": "string", "description": "Account identifier within the external payment provider system", "example": "" }, { "name": "awsRoleArn", "kind": "optional", "type": "string", "description": "AWS IAM role ARN for accessing AWS Marketplace billing integration", "example": "" }, { "name": "awsProductId", "kind": "optional", "type": "string", "description": "AWS Marketplace product identifier for billing integration", "example": "" }, { "name": "awsProductCode", "kind": "optional", "type": "string", "description": "AWS Marketplace product code for billing and entitlement management", "example": "" }, { "name": "awsExternalId", "kind": "optional", "type": "string", "description": "AWS external ID for secure cross-account access verification", "example": "" }, { "name": "awsDimension", "kind": "optional", "type": "string", "description": "AWS Marketplace dimension name for usage-based billing metrics", "example": "" }, { "name": "isTestMode", "kind": "optional", "type": "boolean", "description": "Whether this payment configuration is in test mode for development", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Human-readable name for this payment method configuration", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this specific payment method configuration", "example": "" }, { "name": "createTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when this payment configuration was created", "example": 0 }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when this payment configuration was last modified", "example": 0 } ], "modelRef": "#/components/schemas/payment.payment.AccountPaymentSetting.out", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid request parameters or malformed query", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Authentication required or invalid API key provided", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Insufficient permissions to access payment provider settings", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Account not found or no payment settings configured", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal server error occurred while retrieving payment settings", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "7bybcejT6MukOPIXuDMBh", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/billing-settings/list \\\n --header 'accept: application/json'" }, { "id": "k1hIi70WXpdQyiuVosx5N", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/billing-settings/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "AK5BgP8W8V0g8qF-DDeEC", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/billing-settings/list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "awFbyUFFp5JwVLYi_sC5s", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/billing-settings/list\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "7bybcejT6MukOPIXuDMBh" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Returns array of all payment provider settings configured for the account\n[\n {\n \"accountId\": \"\",\n \"billingSystem\": \"\",\n \"gracePeriod\": \"\",\n \"sendPaymentAutomatically\": false,\n \"emailInvoiceToCustomer\": false,\n \"paymentAccountId\": \"\",\n \"awsRoleArn\": \"\",\n \"awsProductId\": \"\",\n \"awsProductCode\": \"\",\n \"awsExternalId\": \"\",\n \"awsDimension\": \"\",\n \"isTestMode\": false,\n \"name\": \"\",\n \"id\": \"\",\n \"createTimeInMillis\": \"\",\n \"lastUpdateTimeInMillis\": \"\"\n }\n]" }, { "id": "response-1-400", "language": "400", "code": "// Invalid request parameters or malformed query\n" }, { "id": "response-2-401", "language": "401", "code": "// Authentication required or invalid API key provided\n" }, { "id": "response-3-403", "language": "403", "code": "// Insufficient permissions to access payment provider settings\n" }, { "id": "response-4-404", "language": "404", "code": "// Account not found or no payment settings configured\n" }, { "id": "response-5-500", "language": "500", "code": "// Internal server error occurred while retrieving payment settings\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }