BillingMandateDto

The caller's direct debit mandate, refreshed from GoCardless.

Properties

Name	Type	Description
status*	enum	The mandate's state NotStarted PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired
The mandate's state NotStarted PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired
reference*	string	GoCardless's mandate reference
GoCardless's mandate reference
customerId	string	GoCardless's customer identifier
GoCardless's customer identifier
createdDate	string	When the mandate was created
When the mandate was created
isActive*	boolean	Whether payments can be collected: the mandate is active
Whether payments can be collected: the mandate is active
accountHolder	string	The account holder's name, as GoCardless holds it; only for an active mandate
The account holder's name, as GoCardless holds it; only for an active mandate
accountHolderEmail	string	The account holder's email address, as GoCardless holds it; only for an active mandate
The account holder's email address, as GoCardless holds it; only for an active mandate

{
  "status": "NotStarted",
  "reference": "string",
  "customerId": "string",
  "createdDate": "2024-01-01T00:00:00Z",
  "isActive": false
}