Organization API: Customer Portal: Payment preference
The 2 Organization API operations for payment preference.
Part of Customer Portal.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/portal/payment-preference |
Get portal payment preference |
| PATCH | /api/v1/orgs/{org_slug}/portal/payment-preference |
Update account-wide preferred payment currency |
Get portal payment preference
Section titled Get portal payment preferenceGET /api/v1/orgs/{org_slug}/portal/payment-preference
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Update account-wide preferred payment currency
Section titled Update account-wide preferred payment currencyPATCH /api/v1/orgs/{org_slug}/portal/payment-preference
Update account-wide preferred payment currency.
Accepts JSON body { currency, country_code, auto_pay_enabled } (same as
the client API) or legacy query params. Manual updates mark the source as
user so a later geo lookup leaves the choice alone.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
currency |
query | string or null | no |
country_code |
query | string or null | no |
auto_pay_enabled |
query | boolean or null | no |
Request body
Section titled Request bodyapplication/json
Type: object or null.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |