BillingProfileDto
The caller's billing details, kept on their Account Hub billing account: the address their invoices are made out
to and the state of their Direct Debit. Empty (no address, mandate NotStarted) until either is set.
Properties
| Name | Type | Description |
|---|---|---|
| mandateStatus* | enum | The Direct Debit mandate's state |
The Direct Debit mandate's state | ||
| mandateCreatedDate | string | When the mandate was set up (or taken over by Account Hub), if there is one |
When the mandate was set up (or taken over by Account Hub), if there is one | ||
| hasActiveMandate* | boolean | Whether payments can be collected: the mandate is active |
Whether payments can be collected: the mandate is active | ||
| canAcceptPayments* | boolean | Whether a payment could be submitted now: the mandate is active or on its way through the banks |
Whether a payment could be submitted now: the mandate is active or on its way through the banks | ||
| isShared* | boolean | The billing account also pays for Sodium: shown here, changed in Sodium (the profile and mandate writes answer 409) |
The billing account also pays for Sodium: shown here, changed in Sodium (the profile and mandate writes answer 409) | ||
| billingEmail | string | Where invoices are also emailed; only the account's email address when blank |
Where invoices are also emailed; only the account's email address when blank | ||
| companyName | string | The company name invoices are made out to; the user's name when blank |
The company name invoices are made out to; the user's name when blank | ||
| addressLine1 | string | Billing address, first line |
Billing address, first line | ||
| addressLine2 | string | Billing address, second line |
Billing address, second line | ||
| city | string | Billing address town or city |
Billing address town or city | ||
| postcode | string | Billing address postcode |
Billing address postcode | ||
| country | string | Billing address country |
Billing address country | ||
JSON Example
{
"mandateStatus": "NotStarted",
"mandateCreatedDate": "2024-01-01T00:00:00Z",
"hasActiveMandate": false,
"canAcceptPayments": false,
"isShared": false
}