Get Accounts By Organization

GET

/api/accounts/organization/:organization_id

GET

/api/accounts/organization/:organization_id

$ curl https://app.paymentkit.com/api/accounts/organization/organization_id \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "acc_dev_x7k9m2n4p8q1",
4     "name": "Production Environment",
5     "description": "Main production environment",
6     "account_type": "production",
7     "organization_id": "string",
8     "settings": {
9       "auto_deploy": true,
10       "notifications": false
11     },
12     "created_at": "2024-01-15T09:30:00Z",
13     "updated_at": "2024-01-15T09:30:00Z",
14     "is_sandbox": false,
15     "parent_account_id": "acc_dev_abc123",
16     "sandbox_account_count": 1,
17     "is_archived": false,
18     "brand_settings": {
19       "icon": "https://storage.googleapis.com/bucket/icon.png",
20       "icon_dark": "https://storage.googleapis.com/bucket/icon_dark.png",
21       "logo": "https://storage.googleapis.com/bucket/logo.png",
22       "logo_light": "https://storage.googleapis.com/bucket/logo_light.png",
23       "brand_color": "#FF5733",
24       "accent_color": "#3498DB",
25       "custom_domain": "pay.example.com",
26       "privacy_policy_url": "https://example.com/privacy",
27       "terms_of_service_url": "https://example.com/terms",
28       "statement_descriptor_prefix": "ACME"
29     },
30     "invoice_settings": {
31       "billing_address": {
32         "line1": "123 Main St",
33         "line2": "Suite 100",
34         "line3": "Building A",
35         "city": "San Francisco",
36         "state": "CA",
37         "country": "US",
38         "zip_code": "94105"
39       },
40       "tax_ids": [
41         {
42           "value": "PBGPS03456H",
43           "is_default": true
44         }
45       ],
46       "custom_footer": "Thank you for your business!"
47     },
48     "notification_settings": {
49       "invoice": {
50         "on_finalized": true,
51         "on_paid": true
52       },
53       "dunning": {
54         "failed_payment": true
55       },
56       "slack_enabled": true,
57       "slack_webhook_urls": [
58         "string"
59       ],
60       "slack_payment_succeeded": true,
61       "slack_payment_failed": true,
62       "email_enabled": true,
63       "emails_to_notify": [
64         "string"
65       ],
66       "email_payment_succeeded": true,
67       "email_payment_failed": true,
68       "email_config": {
69         "from_email": "billing@example.com",
70         "reply_to_email": "support@example.com",
71         "email_signature_name": "John Smith",
72         "email_signature_title": "Billing Department",
73         "cc_recipients": [
74           "cc1@merchant.com",
75           "cc2@merchant.com"
76         ],
77         "bcc_recipients": [
78           "bcc1@merchant.com",
79           "bcc2@merchant.com"
80         ],
81         "primary_color": "#FF5733",
82         "background_color": "#E8E8E8",
83         "text_color": "#333333"
84       }
85     },
86     "billing_portal_settings": {
87       "allow_update_sub": true,
88       "allow_cancel_sub": true,
89       "upgrade_immediate": true,
90       "cancel_immediate": true,
91       "downgrade_immediate": true,
92       "hide_price_ids": [
93         "price_abc123",
94         "price_def456"
95       ],
96       "support_email": "string"
97     },
98     "dunning_settings": {
99       "enable_retries": true,
100       "enable_emails": true,
101       "contact_info": {
102         "from_email": "billing@example.com",
103         "reply_to_email": "support@example.com",
104         "email_signature_title": "Billing Department",
105         "email_signature_name": "John Smith",
106         "cc_recipients": [
107           "cc1@merchant.com",
108           "cc2@merchant.com"
109         ],
110         "bcc_recipients": [
111           "bcc1@merchant.com",
112           "bcc2@merchant.com"
113         ]
114       },
115       "subscription_status_on_failure": "cancel",
116       "invoice_status_on_failure": "mark_uncollectible",
117       "apply_to_product_ids": [
118         "prod_abc123",
119         "prod_def456"
120       ],
121       "settle_past_due_on_pm_update": true,
122       "update_renewal_on_overdue_paid": true
123     },
124     "checkout_settings": {
125       "session_expiration_minutes": 1440,
126       "enable_posthog": true,
127       "posthog_api_key": "phc_abcdef123456",
128       "posthog_init_keys": {
129         "api_host": "https://app.posthog.com",
130         "autocapture": true
131       },
132       "create_new_customer_per_session": true,
133       "detach_failed_payment_method": true,
134       "enable_promo_code": true,
135       "default_country": "string",
136       "billing_address_country": true,
137       "billing_address_address": true,
138       "billing_address_city_state": true,
139       "billing_address_zip": true,
140       "enable_shipping_address": true,
141       "enable_consent_checkbox": true,
142       "custom_checkbox_text": "string",
143       "custom_footer_text": "string",
144       "allow_duplicate_product_subscriptions": true,
145       "primary_color": "string",
146       "text_color": "string",
147       "background_color": "string"
148     },
149     "fraud_settings": {
150       "enabled": false,
151       "custom_message": "This payment method is not accepted."
152     },
153     "mit_settings": {
154       "cascading_enabled": true,
155       "fallback_processor_1_id": "proc_dev_a1b2c3d4e5f6g7h8",
156       "fallback_processor_2_id": "proc_dev_b2c3d4e5f6g7h8i9",
157       "update_default_pm_on_fallback": false,
158       "max_fallback_payment_methods": 1
159     },
160     "cit_processing_enabled": true,
161     "mit_processing_enabled": true,
162     "default_processor_route_id": "proute_dev_a1b2c3d4e5f6g7h8"
163   }
164 ]

Get all accounts for an organization. Only returns accounts if the authenticated user is a member of the organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organization_idstringRequired

Response

Successful Response

idstring

Unique account identifier

namestring

Account name

descriptionstring or null

Account description

account_typestring

Account type

organization_idstring

Organization ID

settingsmap from strings to any or null

Account settings

created_atdatetime

When the account was created

updated_atdatetime

When the account was last updated

is_sandboxbooleanOptionalDefaults to false

Whether this is a sandbox account for testing

parent_account_idstring or nullOptional

ID of the parent live account (set for sandbox accounts)

sandbox_account_countinteger or nullOptional

Number of sandbox accounts linked to this account (only for live accounts)

is_archivedbooleanOptionalDefaults to false

Whether this account has been archived (soft-deleted)

brand_settingsobject or nullOptional

Brand customization settings for checkout

invoice_settingsobject or nullOptional

Invoice customization settings

notification_settingsobject or nullOptional

Notification settings for invoice/dunning and channels

billing_portal_settingsobject or nullOptional

Billing portal settings for customer self-service

dunning_settingsobject or nullOptional

Dunning settings for failed payment recovery

checkout_settingsobject or nullOptional

Checkout settings for session configuration and analytics

fraud_settingsobject or nullOptional

Fraud protection settings for card blocking

mit_settingsobject or nullOptional

MIT cascade control settings for subscription payments

cit_processing_enabledbooleanOptionalDefaults to true

Whether CIT (checkout/card) processing is enabled

mit_processing_enabledbooleanOptionalDefaults to true

Whether MIT (subscription/recurring) processing is enabled

default_processor_route_idstring or nullOptional

ID of the default processor route for card checkout. A processor route contains an ordered list of processors tried sequentially as a fallback chain. This route is used when no route is specified on a checkout session.

Errors

422

Unprocessable Entity Error