Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
| Property | Definition | Type | Example |
|---|---|---|---|
id | Unique internal identifier for this Account. | integer | 3298435 |
type | Specific type of Account entity. | string | "com.uxpsystems.mint.account.BillingAccount" |
displayName | Optional display-friendly name for the Account. | string | "Jane's Account" |
status | Entity status of the Account. | string | "activated" |
createdDate | Date on which this entity was created, expressed in UNIX Epoch format. | integer | 1543833950000 |
activatedDate | Date on which this entity was activated, expressed in UNIX Epoch format. | integer | 1543833950000 |
updatedDate | Date on which this entity was last updated, expressed in UNIX Epoch format. | integer | 1621622651675 |
suspendedDate | Date on which this entity was suspended, expressed in UNIX Epoch format. | integer | 1527917430000 |
deactivatedDate | Date on which this entity was deactivated, expressed in UNIX Epoch format. | integer | 1794095435804 |
subscriptions | List of all Storefront Gateway Subscriptions under this Account. | array of Storefront Gateway Subscription entities, if any | |
| Note: Each individual Storefront Gateway Subscription may contain, along with its other properties, an array of Features. | |||
attributes | Additional metadata about the entity. |
| Attribute | Definition | Type | Example |
|---|---|---|---|
accountNumber | Human-readable external account number as provided by an external B/OSS or other integration. | string | "123456" |
maxUsers | The maximum number of users with which this account can be shared (i.e, associated). | integer | 5 |
paymentProviderAccountId | Account identifier as stored and/or provided by a payment provider. | string | "098765" |
internalProviderAccountId | If the account is provided by a component internal to MarketONE (e.g. SLM), this attribute contains the internal reference within the appropriate component. | string | "509" |
bssName | The name of the B/OSS (or other integration) that provides the account data. | string | "amdocs" |
paymentDetail | List of available payment methods for this Account. Each object contains: | array of PaymentDetail objects | |
paymentMethodId | Unique identifier of the provider’s payment method. | string | ”97b015f6e65614462fdee” |
paymentMethodName | Name of the provider’s payment method. | string | |
active | Whether or not the payment method is active. | boolean | true |
primary | Whether or not the payment method is the primary payment method for the account. | boolean | false |
additionalFields | Additional metadata related to this payment method object. | string | |
bssAccounts | List of accounts as stored in (and provided by) one or more B/OSS (or other integration) that provides account data. Each object contains: | array of bssAccount objects | |
accountId | Unique identifier of the user’s account in the B/OSS. | string | "000123-45678" |
externalId | Additional unique identifier specified by the B/OSS, if one exists. | string | "123456" |
email | Email address associated with the account in the B/OSS. | string | "jane.smith@email.ca" |
language | User’s preferred language, per ISO 639-1:2002, as specified in the B/OSS. | string | "en-us" |
name | Name of the person associated with the account as specified in the B/OSS. | string | "John Doe" |
addresses | List of addresses associated with the account as specified in the B/OSS. Each bssAddress object includes: | array of bssAddress objects | |
name | Name of the person or contact associated with this address. | string | "Jane Smith" |
street | Full street name of the address. | string | "1 Yonge Street, Suite 405" |
city | City name of the address. | string | "Toronto" |
county | County name of the address, if applicable. | string | "Orange County" |
division | Region the address is domiciled, if applicable. | string | |
postalCode | Postal code of the address. | string | "M5E 1E5" |
country | Country in which the address resides. | string | "Canada" |
phone | Primary phone number associated with this address. | string | "4161234567" |
fax | Primary fax number associated with this address, if applicable. | string | "4160987654" |
latitude | Latitudinal coordinates of this address. | float | 38.8951 |
longitude | Longitudinal coordinates of this address. | float | 77.0364 |
paymentProviderId | The identifier of the payment provider for this account. | string |
Was this page helpful?
