{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "Billing API"
  },
  "host": "api-dev.ezypay.com",
  "basePath": "/",
  "tags": [
    {
      "name": "merchant-controller",
      "description": "Merchants"
    },
    {
      "name": "x-show-objects-payment-method-controller=[PaymentMethodObject]",
      "description": "Payment Methods"
    },
    {
      "name": "note-controller",
      "description": "Notes"
    },
    {
      "name": "x-show-objects-customer-controller=[CustomerObject]",
      "description": "Customers"
    },
    {
      "name": "x-show-objects-settlement-controller=[SettlementObject]",
      "description": "Settlements"
    },
    {
      "name": "x-show-objects-invoice-controller=[InvoiceObject]",
      "description": "Invoices"
    },
    {
      "name": "future-invoice-controller",
      "description": "Future invoices"
    },
    {
      "name": "subscription-controller",
      "description": "Subscriptions"
    },
    {
      "name": "customer-controller",
      "description": "Customers"
    },
    {
      "name": "x-show-objects-plan-controller=[PlanObject]",
      "description": "Plans"
    },
    {
      "name": "transaction-controller",
      "description": "Transactions"
    },
    {
      "name": "x-show-objects-subscription-controller=[SubscriptionObject]",
      "description": "Subscriptions"
    },
    {
      "name": "x-show-objects-credit-note-controller=[CreditNoteObject]",
      "description": "Credit Notes"
    },
    {
      "name": "invoice-controller",
      "description": "Invoices"
    },
    {
      "name": "x-show-objects-transfer-controller=[TransferObject]",
      "description": "Transfers"
    },
    {
      "name": "x-show-objects-note-controller=[NoteObject]",
      "description": "Notes"
    },
    {
      "name": "payment-method-controller",
      "description": "Payment Methods"
    },
    {
      "name": "plan-controller",
      "description": "Plans"
    },
    {
      "name": "settlement-controller",
      "description": "Settlements"
    },
    {
      "name": "x-show-objects-merchant-controller=[MerchantObject]",
      "description": "Merchants"
    },
    {
      "name": "transfer-controller",
      "description": "Transfers"
    },
    {
      "name": "x-show-objects-future-invoice-controller=[FutureInvoiceObject]",
      "description": "Future invoices"
    },
    {
      "name": "credit-note-controller",
      "description": "Credit Notes"
    },
    {
      "name": "x-show-objects-transaction-controller=[TransactionObject]",
      "description": "Transactions"
    }
  ],
  "paths": {
    "/v2/billing/creditnotes": {
      "get": {
        "tags": [
          "credit-note-controller",
          "x-show-objects-credit-note-controller=[CreditNoteObject]"
        ],
        "summary": "List credit notes",
        "description": "Retrieve a list of credit notes using the available filter options.",
        "operationId": "list_credit_note",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "query",
            "description": "Filter by unique identifier of the customer.",
            "required": false,
            "type": "string"
          },
          {
            "name": "subscriptionId",
            "in": "query",
            "description": "Filter by unique identifier of the subscription.",
            "required": false,
            "type": "string"
          },
          {
            "name": "invoiceId",
            "in": "query",
            "description": "Filter by unique identifier of the invoice.",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by credit notes status. Supported values are <code>paid</code>, <code>processing</code>, and <code>failed</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "reason",
            "in": "query",
            "description": "Filter by action taken on the invoice associated to the credit note. Supported values are <code>chargeback</code> and <code>refund</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "from",
            "in": "query",
            "description": "Start date for range of credit notes to view. Filter by date defined in <code>crediNoteDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "until",
            "in": "query",
            "description": "End date for range of credit notes to view. Filter by date defined in <code>crediNoteDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CreditNotesObject"
            }
          }
        }
      }
    },
    "/v2/billing/creditnotes/{creditNoteId}": {
      "get": {
        "tags": [
          "credit-note-controller",
          "x-show-objects-credit-note-controller=[CreditNoteObject]"
        ],
        "summary": "Retrieve a credit note",
        "description": "Get the full details of a credit note.",
        "operationId": "retrieve_credit_note",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "creditNoteId",
            "in": "path",
            "description": "Auto-generated identifier of the credit note.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CreditNoteObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers": {
      "get": {
        "tags": [
          "customer-controller",
          "x-show-objects-customer-controller=[CustomerObject]"
        ],
        "summary": "List customers",
        "description": "Retrieve a list of customers that belong to the merchant.",
        "operationId": "list_customer",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "description": "Customer's name. Max 100 characters.",
            "required": false,
            "type": "string"
          },
          {
            "name": "firstName",
            "in": "query",
            "description": "Customer's first name. Max 50 characters.",
            "required": false,
            "type": "string"
          },
          {
            "name": "lastName",
            "in": "query",
            "description": "Customer's last name. Max 50 characters.",
            "required": false,
            "type": "string"
          },
          {
            "name": "companyName",
            "in": "query",
            "description": "The company name if the company is registered as a customer.",
            "required": false,
            "type": "string"
          },
          {
            "name": "referenceCode",
            "in": "query",
            "description": "The reference code of the customer. A unique identifier from a third-party software integration.",
            "required": false,
            "type": "string"
          },
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Auto-generated numeric identifier of the customer. This identifier is customer facing and is automatically included in all communications to the customer.",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "createdDate",
            "in": "query",
            "description": "The date the customer's record was created.",
            "required": false,
            "type": "string"
          },
          {
            "name": "sortExpression",
            "in": "query",
            "description": "Apply the expression to sort the customer's list based on the preferred argument. For e.g., enter lastname,ASC to sort the customer list in alphabetical order based on the lastname parameter.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, <code>limit</code>=20 will show results 1-20. The default value is 100.",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "To paginate a large result set, use the 'cursor' argument together with the 'limit' argument to specify the number of records to skip or show. For example, <code>limit</code>=10 and <code>cursor</code>=10 will show results for record 11 - 20.",
            "required": false,
            "type": "integer",
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomersObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "customer-controller",
          "x-show-objects-customer-controller=[CustomerObject]"
        ],
        "summary": "Create a customer",
        "description": "Add the customer along with optional details such as address, payment method, and subscriptions which you can provide later on. System does not check for duplication during a new customer creation.",
        "operationId": "create_customer",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "createCustomerCommand",
            "description": "createCustomerCommand",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateCustomer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}": {
      "get": {
        "tags": [
          "customer-controller",
          "x-show-objects-customer-controller=[CustomerObject]"
        ],
        "summary": "Retrieve a customer",
        "description": "Retrieve the customer's personal details, including address, payment method information and any available subscription details.",
        "operationId": "retrieve_customer",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerObject"
            }
          }
        }
      },
      "put": {
        "tags": [
          "customer-controller",
          "x-show-objects-customer-controller=[CustomerObject]"
        ],
        "summary": "Update a customer",
        "description": "Update an existing customer's personal details.",
        "operationId": "update_customer",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "updateCustomerCommand",
            "description": "updateCustomerCommand",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateCustomerCommand"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}/paymentmethods": {
      "get": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "List payment methods",
        "description": "Retrieve a list of payment methods and the details for an existing customer. The list would include both valid and invalid payment methods.",
        "operationId": "list_payment_methods",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodsObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Create a payment method",
        "description": "Links a new payment method token to an existing customer. If the customer has no primary payment method specified, then the new token will become the primary payment method by default. No verification is performed during the linking of payment method.",
        "operationId": "create_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/LinkPaymentMethodToken"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer that will be associated with the payment method token.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}/paymentmethods/primary": {
      "get": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Retrieve primary payment method",
        "description": "Retrieve the payment method details of the customer's primary payment method.",
        "operationId": "retrieve_primary_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}": {
      "get": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Retrieve a payment method",
        "description": "Retrieves the payment method token details that belong to a customer.",
        "operationId": "retrieve_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "paymentMethodToken",
            "in": "path",
            "description": "Auto-generated unique identifier of the payment method token generated by the Ezypay Vault.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodObject"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Delete a payment method",
        "description": "Remove an obsolete or invalid payment method from a customer. Removing a payment method will also delete the payment method token from the Ezypay Vault if no other customers are linked to that token. However, a payment method with an active subscription or is the customer’s only (i.e. primary) payment method cannot be removed.",
        "operationId": "delete_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "paymentMethodToken",
            "in": "path",
            "description": "Auto-generated unique identifier of the payment method token generated by vault.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeletedEntityObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/new": {
      "put": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Replace a payment method",
        "description": "Replace a payment method with another payment method while keeping all existing customer, subscription and invoice links. This is useful when replacing invalid payment methods to existing customers without needing to additionally update their subscription and invoice details. \n\nReplaced payment methods and their linked tokens are then removed from the Vault. However, a payment method with an active subscriptions cannot be removed. Also, if any additional payment methods are still linked to the token, the payment method is removed only from the customer but not from the Vault. ",
        "operationId": "replace_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/SetNewPaymentMethodCommand"
            }
          },
          {
            "name": "paymentMethodToken",
            "in": "path",
            "description": "Auto-generated unique identifier of the payment method token generated by vault.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodObject"
            }
          }
        }
      }
    },
    "/v2/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/primary": {
      "put": {
        "tags": [
          "payment-method-controller",
          "x-show-objects-payment-method-controller=[PaymentMethodObject]"
        ],
        "summary": "Update primary payment method",
        "description": "Change the primary payment method token for an existing customer. Ensure that the new primary token is valid prior to the request.",
        "operationId": "update_primary_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "paymentMethodToken",
            "in": "path",
            "description": "Auto-generated unique identifier of the payment method token generated by vault.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerId",
            "in": "path",
            "description": "Auto-generated unique identifier of the customer.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentMethodObject"
            }
          }
        }
      }
    },
    "/v2/billing/futureinvoices": {
      "get": {
        "tags": [
          "future-invoice-controller",
          "x-show-objects-future-invoice-controller=[FutureInvoiceObject]"
        ],
        "summary": "List future invoices",
        "description": "Retrieve a list of future invoices. The results can then be filtered using the available filter options.",
        "operationId": "list_future_invoices",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "query",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": false,
            "type": "string"
          },
          {
            "name": "customerId",
            "in": "query",
            "description": "Auto-generated unique identifier of the customer.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Maximum records to return per pagination call. Limit can range between 1 to 100 records.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "from",
            "in": "query",
            "description": "Start date for range of future invoices to view. Supported format is YYYY-MM-DD.",
            "required": false,
            "type": "string"
          },
          {
            "name": "until",
            "in": "query",
            "description": "End date for range of future invoices to view. Supported format is YYYY-MM-DD.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/FutureInvoicesObject"
            }
          }
        }
      },
      "put": {
        "tags": [
          "future-invoice-controller",
          "x-show-objects-future-invoice-controller=[FutureInvoiceObject]"
        ],
        "summary": "Update a future invoice",
        "description": "Update the future invoice.",
        "operationId": "update_future_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "updateFutureInvoiceCommand",
            "description": "updateFutureInvoiceCommand",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateFutureInvoiceCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/FutureInvoiceObject"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "future-invoice-controller",
          "x-show-objects-future-invoice-controller=[FutureInvoiceObject]"
        ],
        "summary": "Delete a future invoice",
        "description": "Delete the future invoice.",
        "operationId": "delete_future_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "query",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": false,
            "type": "string"
          },
          {
            "name": "cycleStartDate",
            "in": "query",
            "description": "The start date of the future invoice.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeletedEntityObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices": {
      "get": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "List invoices",
        "description": "Get a list of invoices for a specific merchant, customer or subscription. The invoices are returned sorted by creation date, with the most recently created invoice appearing first.",
        "operationId": "list_invoices",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "query",
            "description": "Filter by unique identifier of the customer.",
            "required": false,
            "type": "string"
          },
          {
            "name": "subscriptionId",
            "in": "query",
            "description": "Filter by unique identifier of the subscription.",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by invoice status. Supported values are <code>paid</code>, <code>processing</code>, <code>past_due</code>, <code>refunded</code> and <code>partially_refunded</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "from",
            "in": "query",
            "description": "Start date for range of invoices to view. Filter by date defined in <code>invoiceDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "until",
            "in": "query",
            "description": "End date for range of invoices to view. Filter by date defined in <code>invoiceDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoicesObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Create an invoice",
        "description": "Create an ad-hoc invoice to bill a customer on an on-demand basis. Invoices created from this end point are not associated to any subscriptions.",
        "operationId": "create_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateInvoice"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices/{invoiceId}": {
      "get": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Retrieve an invoice",
        "description": "Get the full details of an invoice.",
        "operationId": "retrieve_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      },
      "put": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Update an invoice",
        "description": "Change the details of an invoice with status <code>past_due</code>.",
        "operationId": "update_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateInvoicePaymentMethod"
            }
          },
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices/{invoiceId}/recordpayment": {
      "post": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Record an external payment for an invoice",
        "description": "Record a payment from a customer that occurred outside the Ezypay system (for example an over-the-counter cash transaction) and mark the invoice as paid. Only applicable for invoices that have failed payment with status <code>past_due</code>.",
        "operationId": "record_payment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/RecordPayment"
            }
          },
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices/{invoiceId}/refund": {
      "put": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Refund an invoice",
        "description": "Refund an invoice. An online refund will reuse the same invoice payment method that was used in the original transaction.",
        "operationId": "refund_invoice",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/RefundInvoice"
            }
          },
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices/{invoiceId}/retrypayment": {
      "post": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Retry a payment on an invoice",
        "description": "Retry a payment on-demand for an invoice with status <code>past_due</code>.",
        "operationId": "retry_payment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/RetryPayment"
            }
          },
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/invoices/{invoiceId}/writeoff": {
      "post": {
        "tags": [
          "invoice-controller",
          "x-show-objects-invoice-controller=[InvoiceObject]"
        ],
        "summary": "Write off a payment on an invoice",
        "description": "Write-off an invoice on-demand for an invoice with status <code>past_due</code>. The invoice status will be set to <code>writen_off</code> and no billing retries will be attempted for that specific invoice.",
        "operationId": "writeoff_payment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/WriteOffPayment"
            }
          },
          {
            "name": "invoiceId",
            "in": "path",
            "description": "Auto-generated identifier of the invoice.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/InvoiceObject"
            }
          }
        }
      }
    },
    "/v2/billing/merchant": {
      "get": {
        "tags": [
          "merchant-controller",
          "x-show-objects-merchant-controller=[MerchantObject]"
        ],
        "summary": "Retrieve a merchant",
        "description": "Retrieve the business and address details of the respective merchant.",
        "operationId": "retrieve_merchant",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/MerchantObject"
            }
          }
        }
      }
    },
    "/v2/billing/merchant/{merchantId}/notificationsettings": {
      "put": {
        "tags": [
          "merchant-controller",
          "x-show-objects-merchant-controller=[MerchantObject]"
        ],
        "summary": "Update a merchant's notification settings",
        "description": "Update a merchant's notification settings.",
        "operationId": "update_merchants_notification_settings",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateMerchantNotificationSetting"
            }
          },
          {
            "name": "merchantId",
            "in": "path",
            "description": "Identifier of the merchant to update.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/MerchantNotificationResult"
            }
          }
        }
      }
    },
    "/v2/billing/notes": {
      "get": {
        "tags": [
          "note-controller",
          "x-show-objects-note-controller=[NoteObject]"
        ],
        "summary": "List Notes",
        "description": "Retrieve a list of notes that belong ",
        "operationId": "list_notes",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "entity",
            "in": "query",
            "description": "The object type the note belongs to. Supported values are <code>customer</code>, <code>subscription</code>, <code>payment_method</code> and <code>invoice</code>.",
            "required": true,
            "type": "string"
          },
          {
            "name": "entityId",
            "in": "query",
            "description": "Auto-generated identifier of the entity the notes belong to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, <code>limit</code> = 10 shows results 1-10. The default returned result would be 100.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PagingObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "note-controller",
          "x-show-objects-note-controller=[NoteObject]"
        ],
        "summary": "Create Note",
        "description": "Add a note to an associated entity to provide additional descriptive information.",
        "operationId": "create_note",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "createNoteCommand",
            "description": "createNoteCommand",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateNote"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/NoteObject"
            }
          }
        }
      }
    },
    "/v2/billing/notes/{noteId}": {
      "get": {
        "tags": [
          "note-controller",
          "x-show-objects-note-controller=[NoteObject]"
        ],
        "summary": "Get Note Details",
        "description": "Retrieve the note's details.",
        "operationId": "retrieve_note_details",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "noteId",
            "in": "path",
            "description": "Auto-generated identifier of the note.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/NoteObject"
            }
          }
        }
      },
      "put": {
        "tags": [
          "note-controller",
          "x-show-objects-note-controller=[NoteObject]"
        ],
        "summary": "Update Note",
        "description": "Update an existing note along with associated entity that this note belongs to.",
        "operationId": "update_note",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "updateNoteCommand",
            "description": "updateNoteCommand",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateNoteCommand"
            }
          },
          {
            "name": "noteId",
            "in": "path",
            "description": "Auto-generated identifier of the note.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/NoteObject"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "note-controller",
          "x-show-objects-note-controller=[NoteObject]"
        ],
        "summary": "Delete Note",
        "description": "Delete a note associated with an object.",
        "operationId": "delete_note",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "noteId",
            "in": "path",
            "description": "Auto-generated identifier of the note.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeletedEntityObject"
            }
          }
        }
      }
    },
    "/v2/billing/plans": {
      "get": {
        "tags": [
          "plan-controller",
          "x-show-objects-plan-controller=[PlanObject]"
        ],
        "summary": "List plans",
        "description": "Get a list of plans.",
        "operationId": "list_plans",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          },
          {
            "name": "name",
            "in": "query",
            "description": "Filter list of returned plans by name. Partial world search supported. For example, when name=mem, all plans with \"mem\" as part of the name will be returned.",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter list of returned plans by status. Supported values are <code>active</code> or <code>inactive</code>.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PlansObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "plan-controller",
          "x-show-objects-plan-controller=[PlanObject]"
        ],
        "summary": "Create a plan",
        "description": "Plans can be easily created in the Plans section of the Merchant Site, or by using this API to have plans created on the fly.",
        "operationId": "create_plan",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreatePlan"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PlanObject"
            }
          }
        }
      }
    },
    "/v2/billing/plans/{planId}": {
      "get": {
        "tags": [
          "plan-controller",
          "x-show-objects-plan-controller=[PlanObject]"
        ],
        "summary": "Retrieve a plan",
        "description": "Gets the full details of a plan.",
        "operationId": "retrieve_plan",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "planId",
            "in": "path",
            "description": "Identifier of the plan to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PlanObject"
            }
          }
        }
      },
      "put": {
        "tags": [
          "plan-controller",
          "x-show-objects-plan-controller=[PlanObject]"
        ],
        "summary": "Update a plan",
        "description": "Update details of a plan. Changes will be effective for subscriptions created after the update. Existing subscriptions will not be affected and remain grandfathered at terms agreed previously when subscribing to the plan.",
        "operationId": "update_plan",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdatePlan"
            }
          },
          {
            "name": "planId",
            "in": "path",
            "description": "Identifier of the plan to update.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PlanObject"
            }
          }
        }
      }
    },
    "/v2/billing/settlements": {
      "get": {
        "tags": [
          "settlement-controller",
          "x-show-objects-settlement-controller=[SettlementObject]"
        ],
        "summary": "List Settlements",
        "description": "List of settlements",
        "operationId": "list_settlements",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "description": "Start date for range of settlements to view. Filter by settlement run date defined in <code>settlementDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "until",
            "in": "query",
            "description": "End date for range of settlements to view. Filter by settlement run date defined in <code>settlementDate</code>.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SettlementObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions": {
      "get": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "List subscriptions",
        "description": "List all subscriptions belonging to a customer.",
        "operationId": "list_subscriptions",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "query",
            "description": "Auto-generated identifier of the customer.",
            "required": true,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, <code>limit</code> = 10 shows results 1-10. The default returned result would be 100.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionsObject"
            }
          }
        }
      },
      "post": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Create a subscription",
        "description": "Creates a new subscription for a customer. By default, Subscriptions will inherit values from the Plan template. Specify new values in the Subscription to override values inherited from the Plan.",
        "operationId": "create_subscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateSubscription"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions/preview": {
      "post": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Preview a subscription",
        "description": "Before creating a subscription, you can preview a subscription first to double-check that details inherited from the plan object are correct.",
        "operationId": "preview_subscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/PreviewSubscription"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Retrieve a subscription",
        "description": "Retrieves a customer's subscription details.",
        "operationId": "retrieve_subscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions/{subscriptionId}/activate": {
      "put": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Activate a subscription",
        "description": "Activate a pending subscription and promote its status from 'Pending' to 'Active'. An active subscription will then have payment instruction created.",
        "operationId": "activate_subscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "*/*"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ActivatePendingSubscription"
            }
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions/{subscriptionId}/cancel": {
      "put": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Cancel a subscription",
        "description": "Cancel a subscription. Cancellation stops subsequent billing and payment collections but outstanding payments will remain and need to be resolved separately.",
        "operationId": "cancel_subscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/subscriptions/{subscriptionId}/paymentmethod/{paymentMethodToken}": {
      "put": {
        "tags": [
          "subscription-controller",
          "x-show-objects-subscription-controller=[SubscriptionObject]"
        ],
        "summary": "Update subscription's payment method",
        "description": "Update a subscription's payment method.",
        "operationId": "update_subscription_payment_method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Auto-generated unique identifier of the subscription.",
            "required": true,
            "type": "string"
          },
          {
            "name": "paymentMethodToken",
            "in": "path",
            "description": "Auto-generated unique identifier of the payment method token generated by the Ezypay Vault.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/SubscriptionObject"
            }
          }
        }
      }
    },
    "/v2/billing/transactions": {
      "get": {
        "tags": [
          "transaction-controller",
          "x-show-objects-transaction-controller=[TransactionObject]"
        ],
        "summary": "List transactions",
        "description": "Get a list of of transactions for a specific customer or invoice. The transactions are returned sorted by creation date, with the most recently created transactions appearing first.",
        "operationId": "list_transaction",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "transactionNumber",
            "in": "query",
            "description": "Transaction identifier generated by the payment processor.",
            "required": false,
            "type": "string"
          },
          {
            "name": "senderId",
            "in": "query",
            "description": "Identifier of the sender who sent the funds.",
            "required": false,
            "type": "string"
          },
          {
            "name": "receiverId",
            "in": "query",
            "description": "Identifier of the recipient who received the funds..",
            "required": false,
            "type": "string"
          },
          {
            "name": "documentId",
            "in": "query",
            "description": "Identifier of the document that triggered this transaction.",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.",
            "required": false,
            "type": "integer",
            "default": 10,
            "format": "int32"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "An cursor for use in pagination. By specifying the number of objects to skip, you are able to fetch the next page of objects. For example, if you make a list request with limit=10 and cursor=10, you will retrieve objects 11-20 across the full list.",
            "required": false,
            "type": "integer",
            "default": 0,
            "format": "int32"
          },
          {
            "name": "from",
            "in": "query",
            "description": "Start date for range of transactions to view. Filter by date defined in <code>createdOn</code>. Supported format is YYYY-MM-DD.",
            "required": false,
            "type": "string"
          },
          {
            "name": "until",
            "in": "query",
            "description": "End date for range of transactions to view. Filter by date defined in <code>createdOn</code>. Supported format is YYYY-MM-DD.",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "query",
            "description": "State of the transaction attempt. Supported values are <code>success</code>, <code>processing</code>, <code>failed</code>, <code>settled</code> or <code>chargeback</code>.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentsObject"
            }
          }
        }
      }
    },
    "/v2/billing/transactions/{transactionId}": {
      "get": {
        "tags": [
          "transaction-controller",
          "x-show-objects-transaction-controller=[TransactionObject]"
        ],
        "summary": "Retrieve a transaction",
        "description": "Retrieves the full details of a transaction.",
        "operationId": "retrieve_transaction",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "description": "Auto-generated unique identifier of the transaction.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/TransactionObject"
            }
          }
        }
      }
    },
    "/v2/billing/transfers": {
      "post": {
        "tags": [
          "transfer-controller",
          "x-show-objects-transfer-controller=[TransferObject]"
        ],
        "summary": "Create a transfer",
        "description": "Creates an immediate, on-demand transfer of funds between two merchant’s wallet accounts.",
        "operationId": "create_transfer",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "command",
            "description": "command",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateTransfer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/TransferObject"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "SettlementScheduleObject": {
      "type": "object",
      "properties": {
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of settlement. Valid values are <code>day</code>, <code>week</code>or <code>month</code>. If no value is provided, the default value is <code>week</code>."
        },
        "interval": {
          "type": "integer",
          "format": "int32",
          "example": 1,
          "description": "Specifies the number of intervals in settlement frequency. For example <code>interval=2</code> and <code>intervalUnit=\"week\"</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "settlementDay": {
          "type": "string",
          "example": "wednesday",
          "description": "Specifies the day the settlement schedule runs for the merchant.<ul><li>if <code>intervalUnit = \"day\"</code>, then no value required.</li><li>if <code>intervalUnit = \"week\"</code>, then supported values are <code>monday, tuesday, wednesday, thursday</code>, or <code>friday</code>.</li><li>if <code>intervalUnit = \"month\"</code>, then supported values are numbers between 1 to 31. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</li></ul>Note: Settlement schedules can run on weekends but, depending on the payment provider, settlements may only get processed on the next working day."
        },
        "nextSettlementDate": {
          "type": "string",
          "example": "2016-12-07",
          "description": "Auto-generated date for next settlement date."
        }
      },
      "description": "The schedule for settlements."
    },
    "ActivatePendingSubscription": {
      "type": "object",
      "properties": {
        "startDate": {
          "type": "string",
          "description": "The preferred start date of the subscription. The subscription start date cannot be back-dated. If not specified, the subscription will start immediately on the current date (however invoices will be generated the next day). "
        },
        "paymentMethodToken": {
          "type": "string",
          "description": "The payment method token that is generated by the vault."
        }
      }
    },
    "Address": {
      "type": "object",
      "required": [
        "address1"
      ],
      "properties": {
        "address1": {
          "type": "string",
          "example": "86, Help Street",
          "description": "The first line of the address. Max of 100 characters."
        },
        "address2": {
          "type": "string",
          "example": "Chatswood",
          "description": "The second line of the address. If there are no details for this field, you may leave this field blank. Max of 100 characters."
        },
        "postalCode": {
          "type": "string",
          "example": "2067",
          "description": "The postal code of the address. Max of 20 characters."
        },
        "city": {
          "type": "string",
          "example": "Sydney",
          "description": "The town/city of the address. Max of 100 characters."
        },
        "state": {
          "type": "string",
          "example": "NSW",
          "description": "The state of the address. Max of 100 characters."
        },
        "countryCode": {
          "type": "string",
          "example": "AU",
          "description": "The country code of the address. Max of 2 characters."
        }
      }
    },
    "BankObject": {
      "type": "object",
      "properties": {
        "accountHolderName": {
          "type": "string",
          "example": "Matt Zimmer",
          "description": "The account holder's name . Max 50 characters."
        },
        "bankNumber": {
          "type": "string",
          "example": "033088",
          "description": "Identifying number of the bank. Country specific rules."
        },
        "branchNumber": {
          "type": "string",
          "description": "Identifying number for a bank branch. Max of 4 digits for New Zealand."
        },
        "last4": {
          "type": "string",
          "example": "4455",
          "description": "The last 4 digits of the bank account number. Full account number is not displayed for security reasons."
        },
        "suffixNumber": {
          "type": "string",
          "description": "Only required by New Zealand Banks. Must be between 2-3 digits."
        }
      }
    },
    "InvoiceItemCommand": {
      "type": "object",
      "required": [
        "amount",
        "description"
      ],
      "properties": {
        "amount": {
          "description": "Gross amount due for this invoice item, inclusive of tax.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "The tax rate applied to this invoice item. If left blank, uses the tax rate specified in the merchant settings by default.",
          "$ref": "#/definitions/Tax"
        },
        "description": {
          "type": "string",
          "description": "Description of the invoice item."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the invoice item. Max of 50 characters."
        }
      }
    },
    "SetNewPaymentMethodCommand": {
      "type": "object",
      "required": [
        "newPaymentMethodToken"
      ],
      "properties": {
        "newPaymentMethodToken": {
          "type": "string",
          "example": "d5ac31f8-7989-4ee6-aeeb-87bb764aa760",
          "description": "Auto-generated unique identifier of the payment method token generated by vault."
        },
        "primary": {
          "type": "boolean",
          "example": true,
          "description": "Indicator to set this payment method as Customer's preferred Payment Method"
        }
      }
    },
    "CreatePlan": {
      "type": "object",
      "required": [
        "amount",
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "Plan name. Max of 50 characters."
        },
        "memo": {
          "type": "string",
          "example": "Full access to gym facilities & fortnightly billing.",
          "description": "Brief memo of the plan. Max of 50 characters."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the plan's subscription payment. Max of 50 characters."
        },
        "amount": {
          "description": "The gross amount charged to the customer, inclusive of tax. Supports decimal values for cents. For example, $24.50 would  be 24.50.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "The tax rate applied to the plan's amount. If left blank, uses the tax rate specified in the merchant settings by default.",
          "$ref": "#/definitions/Tax"
        },
        "setupPayments": {
          "type": "array",
          "description": "Setup payment settings.",
          "items": {
            "$ref": "#/definitions/SetupPayment"
          }
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of billing. Valid values are <code>day</code>, <code>week</code> or <code>month</code>. If no value is provided, the default value is <code>week</code>. ",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "interval": {
          "type": "integer",
          "format": "int32",
          "example": 2,
          "description": "Number to be specified as interval to manipulate billing frequency. For example <code>interval=2</code> and <code>intervalUnit=week</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "billingStart": {
          "type": "string",
          "example": "immediate",
          "description": "Specifies the default day the billing schedule starts for customers subscribed to the plan. Supported values are:<ul><li><code>immediate</code> - Default value. Subscriptions will start on the same day..<li><code>day_of_week</code> - Subscriptions will start on a specific day as defined in <code>billingStartValue</code>.<li><code>day_of_month</code> - Subscriptions will start on specific day in the month as defined in <code>billingStartValue</code>.</ul>"
        },
        "billingStartValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingStart</code>. If using <code>immediate</code>, no value is required and default value is null.<ul><li>If <code>billingStart</code> = <code>day_of_week</code> then supported values are <code>monday</code>, <code>tuesday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code> and the billing schedule will start on the first up-coming Monday<li>If <code>billingStart</code> = <code>day_of_month</code> then supported values are numbers between 1 to 31. Default value is 1 and the billing schedule will start on the upcoming 1st of the month. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</ul>",
          "readOnly": true
        },
        "billingEnd": {
          "type": "string",
          "example": "ongoing",
          "description": "Specifies the rules to automate when a subscription ends. Supported values are:<ul><li><code>ongoing</code> - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing).<li><code>amount_collected</code> - Subscriptions will end when a specified amount is collected as defined in <code>billingEndValue</code>.<li><code>billing_cycles</code> - Subscriptions will end after a specified number of billing cycles as defined in <code>billingEndValue</code>.<li><code>end_date</code> - Subscriptions will end on specific date. Specify this date when you create a subscription in <code>billingEndValue</code>.</ul>"
        },
        "billingEndValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingEnd</code>. If using <code>ongoing</code>, no value is required and default value is null.<ul><li>If <code>billingEnd</code> = <code>amount_collected</code> then provide an amount to be collected.</li><li>If <code>billingEnd</code> = <code>billing_cycles</code> then provide a number of billing cycles. If it is a one-off plan, set <code>billingEndValue<code> = 1.</li></ul>",
          "readOnly": true
        },
        "firstBilling": {
          "type": "string",
          "example": "prorate",
          "description": "Specifies the rules to auto-calculate the billing charges for the first scheduled billing. Supported values are:<ul><li><code>full_amount</code> - Default value. The first billing will charge the full amount on the subscription as defined in the plan's <code>amount</code>.</li><li><code>prorate</code> - Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.</li></ul>"
        },
        "recurringBillingDay": {
          "type": "string",
          "example": "friday",
          "description": "Only usable when <code>billingStart</code> is set to <code>immediate</code>. Allows you to specify the day recurring billing will occur after the first billing cycle.<ul><li>If <code>intervalUnit</code> = <code>week</code> then supported values are <code>monday</code>, <code>tuesday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code>.</li><li>If <code>intervalUnit</code> = <code>month</code> then supported values are numbers between 1 and 31. Default value is 1. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</li></ul>",
          "readOnly": true
        },
        "metadata": {
          "type": "object",
          "description": "Store additional data about the customer object using key/value pairs format.",
          "additionalProperties": {
            "type": "object"
          }
        }
      }
    },
    "CreditNoteItemObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "30d44924-34f0-4580-b691-f3ec0d2c1b7a",
          "description": "Auto-generated identifier of the credit note item."
        },
        "type": {
          "type": "string",
          "example": "refund_payment",
          "description": "The type of the credit note item."
        },
        "description": {
          "type": "string",
          "example": "Bi-weekly subscription fee",
          "description": "Description."
        },
        "accountingCode": {
          "type": "string",
          "description": "Category of revenue streams for finance reconciliation purposes. For example, different codes can categorise revenue made from different items."
        },
        "amount": {
          "description": "The amount charged for this item.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax rate applied to this item.",
          "$ref": "#/definitions/TaxObject"
        }
      }
    },
    "Tax": {
      "type": "object",
      "properties": {
        "rate": {
          "type": "number",
          "example": 0,
          "description": "Percent number Rate of the specified tax. Range of 0 to 99.99."
        }
      }
    },
    "EmailNotificationSettings": {
      "type": "object",
      "properties": {
        "pastDueInvoice": {
          "example": "true",
          "description": "Flag to turn on notification for Past due invoice",
          "$ref": "#/definitions/Optional«boolean»"
        },
        "paymentMethodCreation": {
          "example": "true",
          "description": "Flag to turn on notification for Payment method creation",
          "$ref": "#/definitions/Optional«boolean»"
        },
        "subscriptionCreation": {
          "example": "true",
          "description": "Flag to turn on notification for Subscription creation",
          "$ref": "#/definitions/Optional«boolean»"
        }
      }
    },
    "CreditNotesObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/CreditNoteObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "CreateSubscription": {
      "type": "object",
      "required": [
        "customerId",
        "planId"
      ],
      "properties": {
        "customerId": {
          "type": "string",
          "example": "8cc57af5-180a-473d-932c-95897a1af970",
          "description": "Auto-generated identifier of the customer."
        },
        "planId": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a3",
          "description": "Auto-generated identifier of the plan."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a2",
          "description": "The payment method token generated by the vault."
        },
        "markAsPending": {
          "type": "boolean",
          "example": false,
          "description": "Default value is <code>false</code>. If set to <code>true</code>, creates a subscription with a Pending status. A pending subscription will ignore <code>subscriptionStartDate</code> and no schedules will be created.\nThe status can be changed to Active using the Activate Subscription API."
        },
        "startDate": {
          "type": "string",
          "example": "2017-01-01",
          "description": "The preferred start date of the subscription. The subscription start date cannot be back-dated. The default value follows the plan's start date. Supported format is YYYY-MM-DD."
        },
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "The name of the plan to subscribe the customer to. Max of 50 characters."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the subscription's payment. Max of 50 characters."
        },
        "amount": {
          "description": "The gross amount charged to the customer, inclusive of tax. Supports decimal values for cents. For example, $24.50 would  be 24.50.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "If provided, each invoice generated for this subscription will include a tax rate.",
          "$ref": "#/definitions/Tax"
        },
        "setupPayments": {
          "type": "array",
          "description": "One-time setup payment applied to the subscription.",
          "items": {
            "$ref": "#/definitions/SetupPayment"
          }
        },
        "interval": {
          "type": "string",
          "example": "2",
          "description": "Number to be specified as interval to manipulate billing frequency. For example <code>interval=2</code> and <code>intervalUnit=week</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of billing. Valid values are <code>day</code>, <code>week</code> or <code>month</code>. If no value is provided, the default value is <code>week</code>. ",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "billingStart": {
          "type": "string",
          "example": "immediate",
          "description": "Specifies the default day the billing schedule starts for customers subscribed to the plan. Supported values are:<ul><li><code>immediate</code> - Default value. Subscriptions will start on the same day.<li><code>day_of_week</code> - Subscriptions will start on a specific day as defined in <code>billingStartValue</code>. Only supported if <code>interval</code> = <code>week</code><li><code>day_of_month</code> - Subscriptions will start on specific day in the month as defined in <code>billingStartValue</code>. Only supported if <code>interval</code> = <code>month</code></ul>"
        },
        "billingStartValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingStart</code>. If using <code>immediate</code>, no value is required and default value is null.<ul><li>If <code>billingStart</code> = <code>day_of_week</code> then supported values are <code>monday</code>, <code>tuesday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code> and the billing schedule will start on the first up-coming Monday<li>If <code>billingStart</code> = <code>day_of_month</code> then supported values are numbers between 1 to 31. Default value is 1 and the billing schedule will start on the upcoming 1st of the month. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</ul>",
          "readOnly": true
        },
        "billingEnd": {
          "type": "string",
          "example": "ongoing",
          "description": "Specifies the rules to automate when a subscription ends. Supported values are:<ul><li><code>ongoing</code> - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing).<li><code>amount_collected</code> - Subscriptions will end when a specified amount is collected as defined in <code>billingEndValue</code>.<li><code>billing_cycles</code> - Subscriptions will end after a specified number of billing cycles as defined in <code>billingEndValue</code>.<li><code>end_date</code> - Subscriptions will end on date defined in <code>billingEndValue</code>.</ul>"
        },
        "billingEndValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingEnd</code>. If using <code>ongoing</code>, no value is required and default value is null.<ul><li>If <code>billingEnd </code> = <code>amount_collected</code> then provide an amount to be collected.</li><li>If <code>billingEnd</code> = <code>billing_cycles</code> then provide a number of billing cycles. If it is a one-off plan, set <code>billingEndValue</code> = 1.</li><li>If <code>billingEnd</code> = <code>end_date</code> then provide a date. Supported format is YYYY-MM-DD.</li></ul>",
          "readOnly": true
        },
        "firstBilling": {
          "type": "string",
          "example": "prorate",
          "description": "Specifies the rules to auto-calculate the billing charges for the first scheduled billing. The default value follows the plan's firstBilling. Supported values are:<ul><li><code>full_amount</code> - The first billing will charge the full amount on the subscription as defined in the plan's amount.</li><li><code>prorate</code> - Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.</li></ul>"
        },
        "firstBillingAmount": {
          "description": "The amount to pay for the subscription's first scheduled billing.",
          "$ref": "#/definitions/Amount"
        },
        "recurringBillingDate": {
          "type": "string",
          "example": "2016-01-06",
          "description": "Allows you to specify the date recurring billing will occur after the first billing cycle. The default value follows the plan's <code>recurringBillingDay</code>. Supported format is YYYY-MM-DD.",
          "readOnly": true
        },
        "metadata": {
          "type": "object",
          "description": "Store additional data about the subscription object using key/value pairs format. Max of 40 characters for key name and 255 characters for key value.",
          "additionalProperties": {
            "type": "object"
          }
        },
        "autoPayment": {
          "type": "boolean",
          "example": false,
          "description": "Specify if auto payment processing occurs for invoices generated from the subscription. Supported value are:<ul><li><code>true</code> = Default value. Invoices generated will automatically proceed to payment processing.</li><li><code>false</code> = Invoices are generated but will not automatically proceed to payment processing.</li></ul>"
        }
      },
      "description": "Subscriptions provides the means for the merchants to collect payments from the customer on a recurring basis."
    },
    "Optional«boolean»": {
      "type": "object"
    },
    "TransactionObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "20c492d9-19c4-44ac-ab96-db813e01c0f8",
          "description": "Auto-generated unique identifier of the payment."
        },
        "number": {
          "type": "string",
          "example": "29008",
          "description": "Transaction identifier generated by the payment processor."
        },
        "status": {
          "type": "string",
          "example": "SUCCESS",
          "description": "State of the transaction attempt. Supported values are <code>success</code>, <code>processing</code>, <code>failed</code>, <code>settled</code> or <code>chargeback</code>."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-02-10T06:04:05.772",
          "description": "DateTime of transaction."
        },
        "failedOn": {
          "type": "string",
          "description": "DateTime when it failed."
        },
        "amount": {
          "description": "Amount transacted in the payment.",
          "$ref": "#/definitions/Amount"
        },
        "type": {
          "type": "string",
          "example": "PAYMENT",
          "description": "Identifies the transaction type. Supported values are <code>Payment</code> when collecting a payment, <code>Refund</code> when processing a refund."
        },
        "source": {
          "type": "string",
          "example": "payment_processor",
          "description": "Identifies the payment source. Supported values are:<ul><li><code>payment_processor</code> - Transaction was processed by payment processors such as banks, credit or debit cards, or direct debits.<li><code>wallet</code> - Transaction occurred within the Ezypay system between escrow accounts.<li><code>external</code> - Transaction occurred outside the Ezypay system and was not processed by Ezypay.</ul>"
        },
        "paymentMethodType": {
          "type": "string",
          "example": "BANK",
          "description": "Payment method type used in the transaction."
        },
        "paymentMethodDescription": {
          "type": "string",
          "example": "4455",
          "description": "Payment method description used in the transaction."
        },
        "failedPaymentReason": {
          "description": "Failed payment reason explaining reason for transaction failure if available.",
          "$ref": "#/definitions/FailedPaymentReasonObject"
        },
        "paymentProviderResponse": {
          "description": "The response of payment provider.",
          "$ref": "#/definitions/PaymentProviderResponseObject"
        },
        "document": {
          "description": "Details of the document that triggered the transaction.",
          "$ref": "#/definitions/DocumentObject"
        },
        "sender": {
          "description": "Details of the sender.",
          "$ref": "#/definitions/SenderObject"
        },
        "receiver": {
          "description": "Details of the receiver.",
          "$ref": "#/definitions/ReceiverObject"
        }
      },
      "description": "Each attempt of sending a customer's payment details to the payment gateway for an invoice or credit note generates a transaction."
    },
    "TransferObject": {
      "type": "object",
      "required": [
        "issuerId",
        "recipientId"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "3a3cd0d2-747f-4f70-9011-49f836613844",
          "description": "Auto-generated identifier of the invoice."
        },
        "documentNumber": {
          "type": "string",
          "example": "100000478",
          "description": "Auto-generated numeric identifier of the invoice. This identifier is customer facing and included in all invoicing related communications with the customer."
        },
        "date": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Issue date of the invoice. Supported format is YYYY-MM-DD."
        },
        "dueDate": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Due date of the invoice.  Supported format is YYYY-MM-DD."
        },
        "status": {
          "type": "string",
          "example": "processing",
          "description": "Current state of the transfer invoice. Set by the transaction state of invoice which can be automated payments or manual merchant actions. Supported values are:<ul><li><code>paid</code> - Settlement run has completed and payment transfer was successful.<li><code>failed</code> - Settlement run was unsuccessful because transaction to pay transfer invoice failed. </ul>"
        },
        "memo": {
          "type": "string",
          "description": "Memo of the invoice."
        },
        "items": {
          "type": "array",
          "description": "Details of the individual items that are included in the invoice.",
          "items": {
            "$ref": "#/definitions/TransferItemResultObject"
          }
        },
        "amount": {
          "description": "Gross amount due for the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalTax": {
          "description": "Total tax amount due for the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "issuerId": {
          "type": "string",
          "example": "cc012b2d-829d-44e9-bb74-c8d6badfca2c",
          "description": "Identifier of the source merchant."
        },
        "recipientId": {
          "type": "string",
          "example": "95115500-486f-4448-9671-0bc06c72c54f",
          "description": "Identifier of the targeted merchant."
        }
      },
      "description": "A transfer occurs when funds are moved between merchant accounts."
    },
    "UpdateInvoicePaymentMethod": {
      "type": "object",
      "properties": {
        "paymentMethodToken": {
          "type": "string",
          "description": "The payment method token that will replace the invoice's current token."
        },
        "scheduledPaymentDate": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Next scheduled payment date. Only applicable if invoice has been scheduled for payment retry. Supported format is YYYY-MM-DD"
        }
      },
      "description": "Update invoice's payment method command"
    },
    "Optional«List«SetupPayment»»": {
      "type": "object"
    },
    "CreditNoteObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "33644a49-52b1-44cc-b715-6ef9ee14ffec",
          "description": "Auto-generated identifier of the credit note."
        },
        "invoiceId": {
          "type": "string",
          "example": "a65f37df-da06-4a7e-8d4b-8664dd92bf61",
          "description": "The invoice this credit note belongs to."
        },
        "documentNumber": {
          "type": "string",
          "example": "100000479",
          "description": "Auto-generated numeric identifier of the credit note. This identifier is customer facing and included in all invoicing related communications with the customer."
        },
        "date": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Issue date of the credit note."
        },
        "status": {
          "type": "string",
          "example": "processing",
          "description": "Current state of the credit note, automated based on the associated payments or manually by merchant actions. Supported values are:<ul><li><code>paid</code> - Credit note has been paid back to the customer accordingly.<li><code>PROCESSING</code> -  Credit note refund transaction is being processed.<li><code>failed</code> - Attempt at refund transaction on credit note failed. This could be because the credit note gateway transaction failed; or because Ezypay won a customer dispute for a chargeback transaction and thus, the credit note is set to failed as funds are reversed back to the merchant.</ul>"
        },
        "items": {
          "type": "array",
          "description": "Credit note items that are part of the credit note.",
          "items": {
            "$ref": "#/definitions/CreditNoteItemObject"
          }
        },
        "amount": {
          "description": "Amount due for the credit note.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalTax": {
          "description": "Total tax amount due for the credit note.",
          "$ref": "#/definitions/AmountObject"
        },
        "reason": {
          "type": "string",
          "description": "The reason of the credit note creation."
        },
        "customerId": {
          "type": "string",
          "example": "05cdadcc-7d55-470f-8b47-34b5d6288ca9",
          "description": "Identifier of the customer the credit note is associated to."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "2ee6e920-966d-4f0a-9419-d6c6104fa25f",
          "description": "Auto-generated unique identifier of the payment method token for this billing schedule."
        }
      },
      "description": "A credit note is issued by a merchant to its customers to specify the money owned by the merchant to the customer. It also serves as a record for filing tax returns for funds refunded to the customer."
    },
    "SettlementDetailsObject": {
      "type": "object",
      "properties": {
        "number": {
          "type": "string",
          "example": "100009",
          "description": "Auto-generated settlement run batch number."
        },
        "date": {
          "type": "string",
          "example": "2017-01-27",
          "description": "Issue date of the settlement."
        },
        "revenue": {
          "description": "The total revenue amount which includes the base payment collected (tax inclusive) and payment received from distribution split, revenue split, distribution adjustment, error adjustment and reverse charge-back.",
          "$ref": "#/definitions/AmountObject"
        },
        "deduction": {
          "description": "The total deduction amount, which includes payment deductions from refunds, chargeback ,distribution adjustments, failed payments, and Ezypay fees that are charged directly to the merchant.",
          "$ref": "#/definitions/AmountObject"
        },
        "amount": {
          "description": "The settlement amount which is total revenue minus total deduction.",
          "$ref": "#/definitions/AmountObject"
        },
        "settlementBankAccount": {
          "description": "The settlement bank account that belongs to the merchant.",
          "$ref": "#/definitions/MerchantPaymentMethodObject"
        },
        "status": {
          "type": "string",
          "example": "success",
          "description": "Status of the settlement run. Supported values are <code>processing</code> or <code>success</code>."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Created date of settlement"
        }
      }
    },
    "PlanSetupPaymentResult": {
      "type": "object",
      "required": [
        "amount"
      ],
      "properties": {
        "amount": {
          "description": "Setup payment amount.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax that is applicable to the setup payment, if the amount is taxable.",
          "$ref": "#/definitions/TaxObject"
        },
        "description": {
          "type": "string",
          "example": "Joining Fee",
          "description": "Description. Max of 255 characters."
        },
        "accountingCode": {
          "type": "string",
          "description": "Accounting code is a category to enable merchants to categorise their revenue for finance reconciliation purpose."
        }
      }
    },
    "PagingObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/NoteObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "FailedPaymentSettingObject": {
      "type": "object",
      "properties": {
        "autoRebill": {
          "type": "boolean",
          "example": true,
          "description": "Flag on whether to turn on auto rebill when a failed payment has occurred."
        },
        "initialFailedPaymentAction": {
          "type": "string",
          "example": "stop",
          "description": "The initial action to perform when a failed payment has occurred. Allowed values are <code>stop</code>, <code>continue</code>.",
          "enum": [
            "STOP",
            "CONTINUE"
          ]
        },
        "maximumFailedAttempts": {
          "type": "integer",
          "format": "int32",
          "example": 4,
          "description": "The maximum number of attempts to charge before billing is stopped."
        },
        "rebillDays": {
          "type": "integer",
          "format": "int32",
          "example": 3,
          "description": "Number of days before a rebill takes place."
        }
      }
    },
    "PreviewSubscription": {
      "type": "object",
      "required": [
        "customerId",
        "planId"
      ],
      "properties": {
        "customerId": {
          "type": "string",
          "example": "8cc57af5-180a-473d-932c-95897a1af970",
          "description": "Auto-generated identifier of the customer."
        },
        "planId": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a3",
          "description": "Auto-generated identifier of the plan."
        },
        "markAsPending": {
          "type": "boolean",
          "example": false,
          "description": "Default value is <code>false</code>. If set to <code>true</code>, creates a subscription with a Pending status. A pending subscription will ignore <code>subscriptionStartDate</code> and no schedules will be created.\nThe status can be changed to Active using the Activate Subscription API."
        },
        "startDate": {
          "type": "string",
          "example": "2017-01-01",
          "description": "The preferred start date of the subscription. The subscription start date cannot be back-dated. The default value follows the plan's start date. Supported format is YYYY-MM-DD."
        },
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "The name of the plan to subscribe the customer to. Max of 50 characters."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the subscription's payment. Max of 50 characters."
        },
        "amount": {
          "description": "The gross amount charged to the customer, inclusive of tax. Supports decimal values for cents. For example, $24.50 would  be 24.50.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "If provided, each invoice generated for this subscription will include a tax rate.",
          "$ref": "#/definitions/Tax"
        },
        "setupPayments": {
          "type": "array",
          "description": "One-time setup payment applied to the subscription.",
          "items": {
            "$ref": "#/definitions/SetupPayment"
          }
        },
        "interval": {
          "type": "string",
          "example": "2",
          "description": "Number to be specified as interval to manipulate billing frequency. For example <code>interval=2</code> and <code>intervalUnit=week</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of billing. Valid values are <code>day</code>, <code>week</code> or <code>month</code>. If no value is provided, the default value is <code>week</code>. ",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "billingStart": {
          "type": "string",
          "example": "immediate",
          "description": "Specifies the default day the billing schedule starts for customers subscribed to the plan. Supported values are:<ul><li><code>immediate</code> - Default value. Subscriptions will start on the same day.<li><code>day_of_week</code> - Subscriptions will start on a specific day as defined in <code>billingStartValue</code>. Only supported if <code>interval</code> = <code>week</code><li><code>day_of_month</code> - Subscriptions will start on specific day in the month as defined in <code>billingStartValue</code>. Only supported if <code>interval</code> = <code>month</code></ul>"
        },
        "billingStartValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingStart</code>. If using <code>immediate</code>, no value is required and default value is null.<ul><li>If <code>billingStart</code> = <code>day_of_week</code> then supported values are <code>monday</code>, <code>tuesday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code> and the billing schedule will start on the first up-coming Monday<li>If <code>billingStart</code> = <code>day_of_month</code> then supported values are numbers between 1 to 31. Default value is 1 and the billing schedule will start on the upcoming 1st of the month. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</ul>",
          "readOnly": true
        },
        "billingEnd": {
          "type": "string",
          "example": "ongoing",
          "description": "Specifies the rules to automate when a subscription ends. Supported values are:<ul><li><code>ongoing</code> - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing).<li><code>amount_collected</code> - Subscriptions will end when a specified amount is collected as defined in <code>billingEndValue</code>.<li><code>billing_cycles</code> - Subscriptions will end after a specified number of billing cycles as defined in <code>billingEndValue</code>.<li><code>end_date</code> - Subscriptions will end on date defined in <code>billingEndValue</code>.</ul>"
        },
        "billingEndValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingEnd</code>. If using <code>ongoing</code>, no value is required and default value is null.<ul><li>If <code>billingEnd </code> = <code>amount_collected</code> then provide an amount to be collected.</li><li>If <code>billingEnd</code> = <code>billing_cycles</code> then provide a number of billing cycles. If it is a one-off plan, set <code>billingEndValue</code> = 1.</li><li>If <code>billingEnd</code> = <code>end_date</code> then provide a date. Supported format is YYYY-MM-DD.</li></ul>",
          "readOnly": true
        },
        "firstBilling": {
          "type": "string",
          "example": "prorate",
          "description": "Specifies the rules to auto-calculate the billing charges for the first scheduled billing. The default value follows the plan's firstBilling. Supported values are:<ul><li><code>full_amount</code> - The first billing will charge the full amount on the subscription as defined in the plan's amount.</li><li><code>prorate</code> - Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.</li></ul>"
        },
        "firstBillingAmount": {
          "description": "The amount to pay for the subscription's first scheduled billing.",
          "$ref": "#/definitions/Amount"
        },
        "recurringBillingDate": {
          "type": "string",
          "example": "2016-01-06",
          "description": "Allows you to specify the date recurring billing will occur after the first billing cycle. The default value follows the plan's <code>recurringBillingDay</code>. Supported format is YYYY-MM-DD.",
          "readOnly": true
        },
        "metadata": {
          "type": "object",
          "description": "Store additional data about the subscription object using key/value pairs format. Max of 40 characters for key name and 255 characters for key value.",
          "additionalProperties": {
            "type": "object"
          }
        },
        "autoPayment": {
          "type": "boolean",
          "example": false,
          "description": "Specify if auto payment processing occurs for invoices generated from the subscription. Supported value are:<ul><li><code>true</code> = Default value. Invoices generated will automatically proceed to payment processing.</li><li><code>false</code> = Invoices are generated but will not automatically proceed to payment processing.</li></ul>"
        }
      }
    },
    "UpdatePlan": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "Plan name. Max of 50 characters."
        },
        "memo": {
          "type": "string",
          "example": "Full access to gym facilities & fortnightly billing.",
          "description": "Brief memo of the plan. Max of 50 characters."
        },
        "amount": {
          "description": "The gross amount charged to the customer, inclusive of tax. Supports decimal values for cents. For example, $24.50 would  be 24.50.",
          "$ref": "#/definitions/Amount"
        },
        "status": {
          "type": "string",
          "description": "Current state of the plan. Supported values are:<ul><li><code>active</code> - Customers can subscribe to the plan.</li><li><code>inactive</code> - Customers are unable to subscribe to the plan.</li></ul>",
          "enum": [
            "ACTIVE",
            "INACTIVE"
          ]
        },
        "setupPayments": {
          "description": "Setup payment settings.",
          "$ref": "#/definitions/Optional«List«SetupPayment»»"
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of billing. Can be <code>day</code>, <code>week</code> or <code>month</code>. If no value is provided, the default value is <code>week</code>.",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "tax": {
          "description": "The tax rate that will be applied to the plan's amount. If left blank, uses the tax rate specified in the Merchant Object by default.",
          "$ref": "#/definitions/Tax"
        },
        "interval": {
          "type": "integer",
          "format": "int32",
          "example": 2,
          "description": "Number to be specified as interval to manipulate billing frequency. For example <code>interval=2</code> and <code>intervalUnit=week</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "billingStart": {
          "type": "string",
          "example": "immediate",
          "description": "Specify the rules to auto-calculate default billing start dates for customers subscribed to the plan. Supported values are <code>weekday</code>, <code>day_of_month</code>, and <code>subscription_date</code>. Must be specified with a corresponding billingStartValue. The default value is <code>subscription_date</code>. This means, by default, schedules created from this plan will start on the start date defined in the customer’s subscription. However, if the scheduled start date and today’s date are the same, then the subscription is marked as starting today but schedules are generated the next day. ",
          "enum": [
            "weekday",
            "day_of_month",
            "subscription_date"
          ]
        },
        "billingStartValue": {
          "type": "string",
          "description": "Specify the value corresponding to billingStart to auto-calculate default billing start date for customers subscribed to the plan. No value required if using subscription_date. Default value is null.\n\n<code>weekday</code> - Set a weekday of either monday, tuesday, wednesday, thursday or friday, automatically defaulting the scheduled start date to the specified weekday. For example, billingStart=<code>weekday</code> and billingStartValue=friday would mean the default start date for the schedule would be on a Friday. If the scheduled weekday and the current day are the same, the scheduled start date starts immediately. If the scheduled start date has already passed for that week (e.g. the current day is Saturday), the schedule will start on next week’s Friday.\n\n<code>day_of_month</code> - Set a number between 1 to 31, automatically defaulting the schedule start date to the specified day of the month. For example, billingStart= <code>day_of_month</code> and billingStartValue=15 would mean the default start date for the schedule would be the 15th of the month. If the scheduled start date matches the current date (e.g. the current date is the 15th), the schedule would start immediately. If the scheduled start date has already passed for that month (e.g. the current date is the 25th), the schedule will start on the 15th of the next month.\nIf the value specified is 29, 30 or 31 and the next month doesn't have these dates, it will automatically be rounded to the last day of the month.\n",
          "readOnly": true
        },
        "billingEnd": {
          "type": "string",
          "description": "Specifies the rules to automate when a subscription ends. Supported values are:<ul><li><code>ongoing</code> - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing).</li><li><code>amount_collected</code> - Subscriptions will end when a specified amount is collected as defined in billingEndValue.</li><li><code>billing_cycles</code> - Subscriptions will end after a specified number of billing cycles as defined in billingEndValue.</li><li><code>end_date</code> - Subscriptions will end on specific date. Specify this date when you create a subscription in <code>billingEndValue</code>.</ul>",
          "enum": [
            "AMOUNT_COLLECTED",
            "BILLING_CYCLES",
            "ONGOING"
          ]
        },
        "billingEndValue": {
          "type": "string",
          "description": "Specifies the value corresponding to billingEnd. If using ongoing, no value is required and default value is null:<ul><li>If <code>billingEnd</code> = <code>amount_collected</code> then provide an amount to be collected.</li><li>If <code>billingEnd</code> = <code>billing_cycles</code> then provide a number of billing cycles. If it is a one-off plan, set <code>billingEndValue</code> = 1.</li></ul>",
          "readOnly": true
        },
        "firstBilling": {
          "type": "string",
          "example": "prorate",
          "description": "Specifies the rules to auto-calculate the billing charges for the first scheduled billing. Supported values are:<ul><li>If <code>full_amount</code> = Default value. The first billing will charge the full amount on the subscription as defined in the plan's amount.</li><li>If <code>prorate </code> =  Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.</li></ul>",
          "enum": [
            "FULL_AMOUNT",
            "PRORATE"
          ]
        },
        "recurringBillingDay": {
          "type": "string",
          "example": "friday",
          "description": "Only usable when billingStart is set to immediate. Allows you to specify the day recurring billing will occur after the first billing cycle.<ul><li>If <code>intervalUnit</code> = <code>week</code> then supported values are <code>monday</code>, <code>tuesdays</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code>, or <code>sunday</code>. Default value is <code>monday</code>.</li><li>If <code>intervalUnit</code> =  <code>month</code> then supported values are numbers between 1 and 31. Default value is 1. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</li></ul>",
          "readOnly": true
        },
        "accountingCode": {
          "description": "Specify an accounting code to categorise revenue collected from the plan's subscription payment. Max of 50 characters.",
          "$ref": "#/definitions/Optional«string»"
        }
      }
    },
    "AddressObject": {
      "type": "object",
      "properties": {
        "address1": {
          "type": "string",
          "example": "86, Help Street",
          "description": "First line of address. Max of 100 characters."
        },
        "address2": {
          "type": "string",
          "example": "Chatswood",
          "description": "Second line of address. Max of 100 characters."
        },
        "city": {
          "type": "string",
          "example": "Sydney",
          "description": "Town or city of address. Max of 100 characters. "
        },
        "countryCode": {
          "type": "string",
          "example": "AU",
          "description": "Two letter ISO 3166-1 alpha-2 country code."
        },
        "postalCode": {
          "type": "string",
          "example": "2067",
          "description": "The postal code of the address. Max of 20 characters"
        },
        "state": {
          "type": "string",
          "example": "NSW",
          "description": "The state of the address. Max of 100 characters"
        }
      }
    },
    "PlanObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a3",
          "description": "Auto-generated identifier of the plan."
        },
        "status": {
          "type": "string",
          "example": "active",
          "description": "Current state of the plan. Supported values are:<ul><li><code>active</code> - Customers can subscribe to the plan.<li><code>inactive</code> - Customers are unable to subscribe to the plan.</ul>"
        },
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "Plan name. Max of 50 characters."
        },
        "memo": {
          "type": "string",
          "example": "Full access to gym facilities & fortnightly billing.",
          "description": "Brief memo of the plan."
        },
        "accountingCode": {
          "type": "string",
          "description": "The category for revenue streams for finance reconciliation purposes."
        },
        "amount": {
          "description": "The amount charged for the plan schedule.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax that is applicable for the plan.",
          "$ref": "#/definitions/TaxObject"
        },
        "setupPayments": {
          "type": "array",
          "description": "The set up payments",
          "items": {
            "$ref": "#/definitions/PlanSetupPaymentResult"
          }
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "Specifies frequency of billing. Valid values are <code>day</code>, <code>week</code> or <code>month</code>. If no value is provided, the default value is <code>week</code>. ",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "interval": {
          "type": "integer",
          "format": "int32",
          "example": 2,
          "description": "Number to be specified as interval to manipulate billing frequency. For example <code>interval=2</code> and <code>intervalUnit=week</code> would means billing every 2 weeks. If no value is provided, the default value is 1."
        },
        "billingStart": {
          "type": "string",
          "example": "immediate",
          "description": "Specifies the default day the billing schedule starts for customers subscribed to the plan. Supported values are:<ul><li><code>immediate</code> - Default value. Subscriptions will start on the same day.<li><code>day_of_week</code> - Subscriptions will start on a specific day as defined in <code>billingStartValue</code>.<li><code>day_of_month</code> - Subscriptions will start on specific day in the month as defined in <code>billingStartValue</code>.</ul>"
        },
        "billingStartValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingStart</code>. If using <code>immediate</code>, no value is required and default value is null.<ul><li>If <code>billingStart</code> = <code>day_of_week</code> then supported values are <code>monday</code>, <code>tuesday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code> and the billing schedule will start on the first up-coming Monday<li>If <code>billingStart</code> = <code>day_of_month</code> then supported values are numbers between 1 to 31. Default value is 1 and the billing schedule will start on the upcoming 1st of the month. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</ul>"
        },
        "billingEnd": {
          "type": "string",
          "example": "ongoing",
          "description": "Specifies the rules to automate when a subscription ends. Supported values are:<ul><li><code>ongoing</code> - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing).<li><code>amount_collected</code> - Subscriptions will end when a specified amount is collected as defined in <code>billingEndValue</code>.<li><code>billing_cycles</code> - Subscriptions will end after a specified number of billing cycles as defined in <code>billingEndValue</code>.<li><code>end_date</code> - Subscriptions will end on specific date. Specify this date when you create a subscription in <code>billingEndValue</code>.</ul>"
        },
        "billingEndValue": {
          "type": "string",
          "description": "Specifies the value corresponding to <code>billingEnd</code>. If using <code>ongoing</code>, no value is required and default value is null.<ul><li>If <code>billingEnd </code> = <code>amount_collected</code> then provide an amount to be collected.</li><li>If <code>billingEnd</code> = <code>billing_cycles</code> then provide a number of billing cycles. If it is a one-off plan, set <code>billingEndValue<code> = 1.</li></ul>"
        },
        "firstBilling": {
          "type": "string",
          "example": "prorate",
          "description": "Specifies the rules to auto-calculate the billing charges for the first scheduled billing. Supported values are:<ul><li><code>full_amount</code> - Default value. The first billing will charge the full amount on the subscription as defined in the plan's <code>amount</code>.</li><li><code>prorate</code> - Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.</li></ul>"
        },
        "recurringBillingDay": {
          "type": "string",
          "example": "friday",
          "description": "Only usable when <code>billingStart</code> is set to <code>immediate</code>. Specifies the day recurring billing will occur after the first billing cycle.<ul><li>If <code>interval</code> = <code>week</code> then supported values are <code>monday</code>, <code>tueday</code>, <code>wednesday</code>, <code>thursday</code>, <code>friday</code>, <code>saturday</code> or <code>sunday</code>. Default value is <code>monday</code>.</li><li>If <code>interval</code> = <code>month</code> then supported values are numbers between 1 and 31. Default value is 1. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.</li></ul>"
        },
        "metadata": {
          "type": "object",
          "description": "Additional data about the plan object using key/value pairs format."
        }
      },
      "description": "A plan serves as a template containing subscription billing details like how much and how often to bill, held against each merchant. Merchants may create an unlimited number of plans, making it really straight forward to offer a variety of different billing cycles, and/or pricing tiers to provide adequate subscription billing choices for all of their products and services."
    },
    "NotificationSettingObject": {
      "type": "object",
      "properties": {
        "pastDueInvoice": {
          "type": "boolean",
          "example": true,
          "description": "Flag to turn on notification for Past due invoice"
        },
        "paymentMethodCreation": {
          "type": "boolean",
          "example": true,
          "description": "Flag to turn on notification for Payment method creation"
        },
        "subscriptionCreation": {
          "type": "boolean",
          "example": true,
          "description": "Flag to turn on notification for Subscription creation"
        }
      }
    },
    "MerchantSettingObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "2ce23869-695d-4f06-b1c8-d667884f1bda",
          "description": "Auto-generated unique identifier of the merchant."
        },
        "acceptedPaymentMethods": {
          "type": "array",
          "example": "[\"visa\",\"mastercard\",\"amex\",\"bank\"]",
          "description": "The list of accepted payment methods supported. Supported values are <code>bank</code>, <code>mastercard</code>, <code>visa</code> and <code>amex</code>.",
          "items": {
            "type": "string"
          }
        },
        "failedPaymentSetting": {
          "description": "The failed payment settings that are applied to a schedule.",
          "$ref": "#/definitions/FailedPaymentSettingObject"
        },
        "tax": {
          "description": "Tax applied to all tax options under the merchant such as within invoices and plans.",
          "$ref": "#/definitions/TaxObject"
        }
      }
    },
    "Paging": {
      "type": "object",
      "properties": {
        "nextUrl": {
          "type": "string",
          "example": "https://api.ezypay.com/v2/billing/customers?limit=10&cursor=10",
          "description": "URL to retrieve the next set of records."
        },
        "nextCursor": {
          "type": "integer",
          "format": "int32",
          "example": 10,
          "description": "Unique identifier indicating the current state in pagination and where to resume the within search results. Using a cursor instead of page numbers avoids returning duplicate records should additional resources be added between pagination calls."
        },
        "limit": {
          "type": "integer",
          "format": "int32",
          "example": 10,
          "description": "Maximum records to return per pagination call. Limit can range between 1 to 100 records."
        },
        "totalCount": {
          "type": "integer",
          "format": "int64",
          "example": 25,
          "description": "Total records that fulfil the search criteria."
        }
      }
    },
    "UpdateMerchantNotificationSetting": {
      "type": "object",
      "properties": {
        "merchantId": {
          "type": "string"
        },
        "customerEmail": {
          "description": "Customer email notification settings",
          "$ref": "#/definitions/Optional«EmailNotificationSettings»"
        }
      }
    },
    "TransferItemResultObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "30d44924-34f0-4580-b691-f3ec0d2c1b7a",
          "description": "Auto-generated identifier of the transfer invoice item."
        },
        "description": {
          "type": "string",
          "description": "Description."
        },
        "type": {
          "type": "string",
          "example": "transfer_payment",
          "description": "The type of the transfer invoice item."
        },
        "amount": {
          "description": "The amount charged for this item.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax rate applied to this item.",
          "$ref": "#/definitions/TaxObject"
        }
      }
    },
    "SenderObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "20c492d9-19c4-44ac-ab96-db813e01c0f8",
          "description": "Identifier of the party associated to this transaction."
        },
        "name": {
          "type": "string",
          "example": "The Orange Nation Gym ",
          "description": "Name of the party involved in the transaction."
        },
        "type": {
          "type": "string",
          "example": "merchant",
          "description": "Specifies the type. Supported values are:  <code>customer</code>, <code>merchant</code>, and <code>Ezypay</code>."
        }
      }
    },
    "CreateInvoice": {
      "type": "object",
      "required": [
        "customerId",
        "items"
      ],
      "properties": {
        "customerId": {
          "type": "string",
          "example": "05cdadcc-7d55-470f-8b47-34b5d6288ca9",
          "description": "Identifier of the customer the invoice is billed to."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "d5ac31f8-7989-4ee6-aeeb-87bb764aa760",
          "description": "The payment method token that is generated by the vault."
        },
        "memo": {
          "type": "string",
          "example": "Zumba class reservation",
          "description": "Description of the invoice item. Max of 100 characters."
        },
        "items": {
          "type": "array",
          "description": "Details of the individual items that are included in the invoice.",
          "items": {
            "$ref": "#/definitions/InvoiceItemCommand"
          }
        },
        "autoPayment": {
          "type": "boolean",
          "example": false,
          "description": "Determines if auto payment processing occurs for invoices generated from the subscription. Supported value are:<ul><li><code>true</code> = Default value. Invoices generated will automatically proceed to payment processing.</li><li><code>false</code> = Invoices are generated but will not automatically proceed to payment processing.</li></ul>"
        }
      }
    },
    "FutureInvoicesObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/FutureInvoiceObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "InvoicesObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/InvoiceObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "PaymentProviderResponseObject": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Response code from the payment provider."
        },
        "description": {
          "type": "string",
          "description": "Description of reason from the payment provider."
        }
      }
    },
    "LinkPaymentMethodToken": {
      "type": "object",
      "required": [
        "paymentMethodToken"
      ],
      "properties": {
        "paymentMethodToken": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a2",
          "description": "Auto-generated unique identifier of the payment method token generated by the Ezypay Vault."
        },
        "primary": {
          "type": "boolean",
          "example": false,
          "description": "Specifies this token as the customer's preferred token for making payments. Supported values are <code>true</code> and <code>false</code>.\nIf the customer has no primary payment method specified, then the new token will become the primary payment method by default. However, if the owner already has a primary payment method, then it will not change unless <code>primary</code> is set to <code>true</code>."
        }
      }
    },
    "ReceiverObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "20c492d9-19c4-44ac-ab96-db813e01c0f8",
          "description": "Identifier of the party associated to this transaction."
        },
        "name": {
          "type": "string",
          "example": "The Orange Nation Gym ",
          "description": "Name of the party involved in the transaction."
        },
        "type": {
          "type": "string",
          "example": "merchant",
          "description": "Specifies the type. Supported values are:  <code>customer</code>, <code>merchant</code>, and <code>Ezypay</code>."
        }
      }
    },
    "LineItemObject": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "example": "subscription_payment",
          "description": "The type of the future invoice item."
        },
        "description": {
          "type": "string",
          "example": "Bi-weekly subscription fee",
          "description": "Description."
        },
        "accountingCode": {
          "type": "string",
          "description": "Category of revenue streams for finance reconciliation purposes. For example, different codes can categorise revenue made from different items."
        },
        "amount": {
          "description": "The amount charged for this item.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax rate applied to this item.",
          "$ref": "#/definitions/TaxObject"
        }
      }
    },
    "CreateTransfer": {
      "type": "object",
      "required": [
        "issuerId",
        "items",
        "recipientId"
      ],
      "properties": {
        "issuerId": {
          "type": "string",
          "example": "cc012b2d-829d-44e9-bb74-c8d6badfca2c",
          "description": "Identifier of the merchant who issue invoice."
        },
        "recipientId": {
          "type": "string",
          "example": "95115500-486f-4448-9671-0bc06c72c54f",
          "description": "Identifier of the merchant who receive invoice."
        },
        "memo": {
          "type": "string",
          "example": "This is a transfer invoice",
          "description": "Memo of the invoice."
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TransferItemCommand"
          }
        }
      }
    },
    "TaxObject": {
      "type": "object",
      "properties": {
        "rate": {
          "type": "number",
          "example": 10,
          "description": "Rate of the tax that is implemented."
        }
      }
    },
    "GenerateCustomerTaxInvoiceCommand": {
      "type": "object",
      "properties": {
        "documentType": {
          "type": "string",
          "example": "tax_invoice",
          "description": "Specify the type of document generated from the invoice. Supported values are:\ntax_invoice: Generates a customer tax invoice PDF."
        }
      }
    },
    "NoteObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "b5e2bb20-f341-4bc2-9487-443127dc4f7e",
          "description": "Auto-generated unique identifier of the note."
        },
        "message": {
          "type": "string",
          "example": "Recruit your fit squad to join our special in-house fitness programme. Stay Orange!",
          "description": "The note's content message."
        },
        "entity": {
          "type": "string",
          "example": "customer",
          "description": "The entity linked to the note. Supported values are  <code>customer</code>, <code>subscription</code>, <code>payment_method</code> and <code>invoice</code>."
        },
        "entityId": {
          "type": "string",
          "example": "05cdadcc-7d55-470f-8b47-34b5d6288ca9",
          "description": "The unique identified of the entity associated with the note."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-02-10T13:02:17.764",
          "description": "Timestamp the note was created."
        }
      },
      "description": "Notes can be entered to track further information in relation to changes and actions performed across a customer, subscription, invoice and more."
    },
    "SubscriptionsObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/SubscriptionObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "FutureInvoiceItemCommand": {
      "type": "object",
      "required": [
        "amount"
      ],
      "properties": {
        "type": {
          "type": "string",
          "example": "subscription_payment",
          "description": "Specifies the payment type of the future invoice. Supported values are:<ul><li><code>subscription_payment</code> - Updates the original payment invoice item. If not specified, then the amount will remain unchanged as defined in the original subscription.</li><li><code>addon_payment</code> - Generates an additional payment invoice item in addition to the subscription. If not specified, then any previously created <code>addon_payment</code> invoice items will be removed from the invoice.</li><li><code>setup_payment</code> - Updates the setup payment invoice item. If not specified, then the <code>setup_payment</code> is removed from the invoice. Setup payment changes are only applicable for the first invoice of a subscription.</li></ul>Default to subscription_payment",
          "enum": [
            "subscription_payment",
            "addon_payment",
            "setup_payment"
          ]
        },
        "amount": {
          "description": "Amount of the invoice item.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "The tax rate applied to this invoice item. If left blank, uses the tax rate specified in the merchant settings by default.",
          "$ref": "#/definitions/Tax"
        },
        "description": {
          "type": "string",
          "example": "Bi-weekly subscription fee",
          "description": "The description of the future invoice item."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the invoice item. Max of 50 characters."
        }
      }
    },
    "GenerateSettlementFileCommand": {
      "type": "object",
      "required": [
        "documentType"
      ],
      "properties": {
        "documentType": {
          "type": "string",
          "example": "tax_invoice",
          "description": "Specify the type of document generated from the settlement. Supported values are:\ntax_invoice: Generates a settlement tax invoice PDF.\ndetail_report: Generates a full report (in .csv format) on the settlement status of payment collections from customers."
        }
      }
    },
    "FailedPaymentReasonObject": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Error code for failed payment."
        },
        "description": {
          "type": "string",
          "description": "Description of reason for failed payment."
        }
      }
    },
    "Optional«string»": {
      "type": "object"
    },
    "AmountObject": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "example": "AUD",
          "description": "Three letter ISO 4217 currency code for the amount."
        },
        "value": {
          "type": "number",
          "example": 10,
          "description": "The value of amount."
        }
      }
    },
    "CustomerObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "8cc57af5-180a-473d-932c-95897a1af970",
          "description": "Auto-generated unique identifier of the customer."
        },
        "number": {
          "type": "integer",
          "format": "int64",
          "example": 26216251,
          "description": "Auto-generated numeric identifier of the customer. This identifier is customer facing and is automatically included in all communications to the customer."
        },
        "referenceCode": {
          "type": "string",
          "example": "ME-8827",
          "description": "Reference code that can be defined by you. This can be used to store a code used by your application to identify the customer. Max of 30 characters."
        },
        "firstName": {
          "type": "string",
          "example": "Matt",
          "description": "Customer first name. Max of 50 characters."
        },
        "lastName": {
          "type": "string",
          "example": "Zimmer",
          "description": "Customer last name. Max of 50 characters."
        },
        "email": {
          "type": "string",
          "example": "matt.zimmer78@gmail.com",
          "description": "Customer email. Max of 255 characters."
        },
        "companyName": {
          "type": "string",
          "example": "Ezypay",
          "description": "The company name if the company is registered as a customer. Max of 100 characters"
        },
        "mobilePhone": {
          "type": "string",
          "example": "4126740923",
          "description": "Customer mobile phone number. Max of 50 characters."
        },
        "homePhone": {
          "type": "string",
          "example": "0294101010",
          "description": "Customer home phone number. Max if 50 characters."
        },
        "gender": {
          "type": "string",
          "example": "male",
          "description": "Customer gender. Supported values are <code>male</code> or <code>female</code>."
        },
        "dateOfBirth": {
          "type": "string",
          "example": "1978-06-25",
          "description": "Customer date of birth. Supported format is YYYY-MM-DD."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-01-25",
          "description": "DateTime the customer was created. Supported format is YYYY-MM-DD."
        },
        "address": {
          "description": "Customer addresses. Customers can have multiple addresses.",
          "$ref": "#/definitions/AddressObject"
        },
        "metadata": {
          "type": "object",
          "description": "Additional data about the customer object using key/value pairs format."
        }
      },
      "description": "Customers are profiles containing information about a person billed by Ezypay. "
    },
    "CreateNote": {
      "type": "object",
      "required": [
        "entity",
        "entityId",
        "message"
      ],
      "properties": {
        "message": {
          "type": "string",
          "example": "Recruit your fit squad to join our special in-house fitness programme. Stay Orange!",
          "description": "The note's content message. Max of 255 characters."
        },
        "entity": {
          "type": "string",
          "example": "customer",
          "description": "The object type the note belongs to. Supported values are <code>customer</code>, <code>subscription</code>, <code>payment_method</code>, <code>transaction</code> and <code>invoice</code>."
        },
        "entityId": {
          "type": "string",
          "example": "05cdadcc-7d55-470f-8b47-34b5d6288ca9",
          "description": "The unique identified of the entity associated with the note."
        }
      }
    },
    "UpdateCustomerCommand": {
      "type": "object",
      "required": [
        "email",
        "firstName",
        "lastName"
      ],
      "properties": {
        "email": {
          "type": "string",
          "example": "matt.zimmer78@gmail.com",
          "description": "A valid email address that belongs to the customer. Max of 255 characters."
        },
        "firstName": {
          "type": "string",
          "example": "Matt",
          "description": "Customer's first name. Max of 50 characters."
        },
        "lastName": {
          "type": "string",
          "example": "Zimmer",
          "description": "Customer's last name. Max of 50 characters."
        },
        "gender": {
          "type": "string",
          "example": "male",
          "description": "Customer gender. Supported values are <code>male</code> or <code>female</code>."
        },
        "homePhone": {
          "type": "string",
          "description": "Customer home phone number. Max of 50 characters."
        },
        "mobilePhone": {
          "type": "string",
          "example": "4126740923",
          "description": "Customer mobile phone number. Max of 50 characters."
        },
        "referenceCode": {
          "type": "string",
          "example": "ME-8827",
          "description": "The reference code of the customer. A unique identifier from a third-party software integration. Max of 30 characters."
        },
        "companyName": {
          "type": "string",
          "description": "The company name if the company is registered as a customer. Max of 100 characters."
        },
        "dateOfBirth": {
          "type": "string",
          "example": "1978-06-25",
          "description": "Customer's date of birth. Supported format is YYYY-MM-DD."
        },
        "address": {
          "description": "The customer's address object that holds address details.",
          "$ref": "#/definitions/Address"
        }
      }
    },
    "SettlementObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/SettlementDetailsObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "RecordPayment": {
      "type": "object",
      "properties": {
        "paymentMethodType": {
          "type": "string",
          "description": "The external payment method used by the customer to pay for the invoice. Supported values are <code>cash</code>, <code>cheque</code>, <code>card</code>, <code>others</code> and <code>bank_transfer</code>."
        }
      }
    },
    "CardObject": {
      "type": "object",
      "properties": {
        "accountHolderName": {
          "type": "string",
          "description": "The credit/debit card owner's name which is printed on the card. Max length 50 characters."
        },
        "expiryMonth": {
          "type": "string",
          "description": "The credit/debit card expiry month in (MM) format e.g 05"
        },
        "expiryYear": {
          "type": "string",
          "description": "The credit/debit card expiry year in (YY) format e.g 18"
        },
        "first6": {
          "type": "string",
          "description": "The first 6 digits of the credit/debit card number. Full card number is not displayed for security reasons."
        },
        "last4": {
          "type": "string",
          "description": "The last 4 digits of the credit/debit card number. Full card number is not displayed for security reasons."
        },
        "type": {
          "type": "string",
          "description": "The card type of the card token."
        }
      }
    },
    "TransferItemCommand": {
      "type": "object",
      "required": [
        "amount",
        "description"
      ],
      "properties": {
        "description": {
          "type": "string",
          "description": "Description of the invoice item."
        },
        "amount": {
          "description": "Gross amount due for this invoice item, inclusive of tax.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "Tax rate applied to this invoice item. If left blank, uses the tax specified in the Merchant Object by default.",
          "$ref": "#/definitions/Tax"
        },
        "accountingCode": {
          "type": "string",
          "description": "Accounting code."
        }
      }
    },
    "SetupPayment": {
      "type": "object",
      "required": [
        "amount"
      ],
      "properties": {
        "amount": {
          "description": "Setup payment amount.",
          "$ref": "#/definitions/Amount"
        },
        "tax": {
          "description": "The tax that is applicable to the setup payment, if the amount is taxable.",
          "$ref": "#/definitions/Tax"
        },
        "description": {
          "type": "string",
          "example": "Joining Fee",
          "description": "Description. Max of 255 characters."
        },
        "accountingCode": {
          "type": "string",
          "description": "Specify an accounting code to categorise revenue collected from the setup payment. Max of 50 characters."
        }
      }
    },
    "InvoiceItemObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "60b16c85-9de3-45d1-918a-626d52537dbb",
          "description": "Auto-generated identifier of the invoice item."
        },
        "type": {
          "type": "string",
          "example": "on_demand_payment",
          "description": "The type of the invoice item."
        },
        "description": {
          "type": "string",
          "example": "Bi-weekly subscription fee",
          "description": "Description."
        },
        "accountingCode": {
          "type": "string",
          "description": "The category for revenue streams for finance reconciliation purposes. For example, different codes can categorise revenue made from different items."
        },
        "amount": {
          "description": "The amount charged for this item.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "The tax rate applied to this item.",
          "$ref": "#/definitions/TaxObject"
        }
      },
      "description": "Invoice items are held against invoices, fully breaking down all the charges that make up an invoice. Invoices can contain multiple invoice items. Each invoice item can be generated based on schedules of a subscription, or created on an ad-hoc basis without a schedule to itemise charges in an invoice and billed accordingly."
    },
    "FutureInvoiceObject": {
      "type": "object",
      "properties": {
        "subscriptionId": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a2",
          "description": "Auto-generated unique identifier of the subscription."
        },
        "date": {
          "type": "string",
          "example": "2016-01-15",
          "description": "The date that the invoice will be generated."
        },
        "cycleStartDate": {
          "type": "string",
          "example": "2016-01-15",
          "description": "The start date of the cycle."
        },
        "cycleEndDate": {
          "type": "string",
          "example": "2016-01-28",
          "description": "The end date of the cycle."
        },
        "items": {
          "type": "array",
          "description": "List of invoice item result.",
          "items": {
            "$ref": "#/definitions/LineItemObject"
          }
        },
        "amount": {
          "description": "Total amount of all items in the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalTax": {
          "description": "Total tax of all items in the invoice.",
          "$ref": "#/definitions/AmountObject"
        }
      },
      "description": "Ezypay automatically generates future invoices based on information held in customer subscriptions to provide full clarity on all future billings, while also enabling and easing the process of performing variations to future billings."
    },
    "PlansObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/PlanObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "PaymentMethodObject": {
      "type": "object",
      "properties": {
        "paymentMethodToken": {
          "type": "string",
          "example": "d5ac31f8-7989-4ee6-aeeb-87bb764aa760",
          "description": "Auto-generated unique identifier of the payment method token generated by vault."
        },
        "customerId": {
          "type": "string",
          "example": "8302db87-1c09-4503-a885-256b1b6dc475",
          "description": "Auto-generated unique identifier of the customer that the card token is associated to."
        },
        "type": {
          "type": "string",
          "example": "bank",
          "description": "The payment method type of the token."
        },
        "bank": {
          "description": "The bank details of the token.",
          "$ref": "#/definitions/BankObject"
        },
        "card": {
          "description": "The card details of the token.",
          "$ref": "#/definitions/CardObject"
        },
        "primary": {
          "type": "boolean",
          "example": false,
          "description": "Indicate whether the bank account or card is the primary payment method for the customer."
        },
        "valid": {
          "type": "boolean",
          "example": false,
          "description": "Indicate if the bank account or card has become invalid, due to reasons such as bank account closure, expired card or withdrawn debit authority."
        },
        "invalidReason": {
          "description": "The reason a bank account or card is no longer valid for collecting payments from the customer.",
          "$ref": "#/definitions/InvalidReasonResponseObject"
        },
        "lastUsedOn": {
          "type": "string",
          "description": "This payment method was last used on."
        }
      },
      "description": "Payment methods are held against customers, securely encrypted and stored in Ezypay's PCI Compliant Vault. Supported payment methods are bank and credit/debit cards, depending on country and merchant settings."
    },
    "RefundInvoice": {
      "type": "object"
    },
    "Optional«EmailNotificationSettings»": {
      "type": "object"
    },
    "MerchantNotificationResult": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "2ce23869-695d-4f06-b1c8-d667884f1bda",
          "description": "Auto-generated unique identifier of the merchant."
        },
        "customerEmail": {
          "example": "true",
          "description": "Customer email notification settings",
          "$ref": "#/definitions/NotificationSettingObject"
        }
      }
    },
    "MerchantPaymentMethodObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "c5bf77c5-5b47-4df8-ac9d-ca527bea4828",
          "description": "Auto-generated unique identifier of the merchant that the card token is associated to."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "25ae40ce-49cf-441a-944b-e7ad36dc7700",
          "description": "Auto-generated unique identifier of the payment method token generated by vault."
        },
        "bank": {
          "description": "The bank details of the token.",
          "$ref": "#/definitions/BankObject"
        }
      },
      "description": "The payment method (bank) that is associated to the merchant. Merchant can be associated with only one bank payment method."
    },
    "Amount": {
      "type": "object",
      "required": [
        "currency",
        "value"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "example": "AUD",
          "description": "ISO 4217 Currency code for the amount."
        },
        "value": {
          "type": "number",
          "example": 10,
          "description": "The value of amount."
        }
      }
    },
    "DocumentObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "20c492d9-19c4-44ac-ab96-db813e01c0f8",
          "description": "Identifier of the document that triggered this transaction."
        },
        "number": {
          "type": "string",
          "example": "100000418",
          "description": "Auto-generated numeric identified of the document that triggered this transaction."
        }
      }
    },
    "PaymentsObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/TransactionObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "UpdateFutureInvoiceCommand": {
      "type": "object",
      "required": [
        "cycleStartDate",
        "date",
        "subscriptionId"
      ],
      "properties": {
        "subscriptionId": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a2",
          "description": "Auto-generated unique identifier of the subscription."
        },
        "cycleStartDate": {
          "type": "string",
          "example": "2016-01-01",
          "description": "The billing cycle start date. Supported format is YYYY-MM-DD."
        },
        "date": {
          "type": "string",
          "example": "2016-01-02",
          "description": "The date the invoice will be issued to the customer. Supported format is YYYY-MM-DD."
        },
        "items": {
          "type": "array",
          "description": "Details of the individual items that are included in the future invoice. Max of 255 characters.",
          "items": {
            "$ref": "#/definitions/FutureInvoiceItemCommand"
          }
        }
      }
    },
    "PaymentMethodsObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/PaymentMethodObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "WriteOffPayment": {
      "type": "object"
    },
    "SubscriptionObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "7e98596c-0091-40ec-8def-738243647e8e",
          "description": "Auto-generated identifier of the subscription."
        },
        "customerId": {
          "type": "string",
          "example": "8cc57af5-180a-473d-932c-95897a1af970",
          "description": "Auto-generated unique identifier of the customer that the subscription is associated to."
        },
        "planId": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a3",
          "description": "Auto-generated identifier of the plan where this subscription was instantiated from."
        },
        "name": {
          "type": "string",
          "example": "Orange Plan Fortnightly",
          "description": "The name of the subscription, which is copied over from the plan's name."
        },
        "status": {
          "type": "string",
          "example": "active",
          "description": "Current state of the subscription. Supported values are:<ul><li><code>pending</code> - The subscription has not yet been activated and has no start date set.</li><li><code>future</code> - The subscription start date is on a future date.</li><li><code>active</code> - The subscription is actively being billed.</li><li><code>past_due</code> The subscription has an invoice with a status that is <code>past_due</code>.</li><li><code>completed</code> - The subscription has ended and reached the end billing requirements as defined in <code>billingEnd</code>.</li><li><code>cancelled </code> -  The subscription was cancelled by the merchant, before completing its course.</li></ul>"
        },
        "startDate": {
          "type": "string",
          "example": "2017-01-01",
          "description": "The subscription's start date."
        },
        "endDate": {
          "type": "string",
          "example": "2018-01-01",
          "description": "The subscription's end date."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "03426a7f-fa7e-447a-a639-bd00023a67a2",
          "description": "Auto-generated unique identifier of the payment method token for this billing schedule."
        },
        "accountingCode": {
          "type": "string",
          "description": "The category for revenue streams for finance reconciliation purposes."
        },
        "amount": {
          "description": "The schedule's amount to be charge for each interval.",
          "$ref": "#/definitions/AmountObject"
        },
        "tax": {
          "description": "If provided, each invoice generated for this subscription will include a tax rate, but the amount charged to the customer will not be increased.",
          "$ref": "#/definitions/TaxObject"
        },
        "nextBillingDate": {
          "type": "string",
          "example": "2017-01-01",
          "description": "The upcoming date where the customer will be charged for this subscription."
        },
        "nextFutureInvoice": {
          "description": "Details of the next upcoming invoice.",
          "$ref": "#/definitions/FutureInvoiceObject"
        },
        "interval": {
          "type": "integer",
          "format": "int32",
          "example": 2,
          "description": "The schedule's intervals."
        },
        "intervalUnit": {
          "type": "string",
          "example": "week",
          "description": "The schedule's interval unit."
        },
        "totalPaid": {
          "description": "Total payment collected for this subscription so far.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalBillingCycles": {
          "type": "integer",
          "format": "int32",
          "example": 0,
          "description": "Total payment cycle processed for this subscription far."
        },
        "remainingToPay": {
          "description": "Total remaining payments to be collected for this subscription, if it is a recurring.",
          "$ref": "#/definitions/AmountObject"
        },
        "remainingBillingCycles": {
          "type": "integer",
          "format": "int32",
          "description": "Total remaining payment cycles to be processed for this subscription."
        },
        "endTargetAmount": {
          "description": "The schedule's total amount to be collected.",
          "$ref": "#/definitions/AmountObject"
        },
        "endTargetBillingCycles": {
          "type": "integer",
          "format": "int32",
          "example": 0,
          "description": "The schedule's total cycles to be collected."
        },
        "cancelledDate": {
          "type": "string",
          "description": "The date that the cancellation will be effective on."
        },
        "metadata": {
          "type": "object",
          "description": "Store additional data about the subscription object using key/value pairs format."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Created date of subscription"
        }
      },
      "description": "Subscriptions provides the means for the merchants to collect payments from the customer on a recurring basis."
    },
    "FileResult": {
      "type": "object",
      "properties": {
        "fileId": {
          "type": "string",
          "example": "3a3cd0d2-747f-4f70-9011-49f836613844",
          "description": "Auto-generated identifier of the file."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-05-15T07:16:53.566",
          "description": "Auto-generated date and time of file generation."
        },
        "documentType": {
          "type": "string",
          "example": "tax_invoice",
          "description": "The type of document generated from the settlement. Supported values are:\ntax_invoice: Generates a settlement tax invoice PDF.\ndetail_report: Generates a full report (in .csv format) on the settlement status of payment collections from customers."
        }
      }
    },
    "MerchantObject": {
      "type": "object",
      "properties": {
        "countryCode": {
          "type": "string",
          "example": "AU",
          "description": "Two letter ISO 3166-1 alpha-2 country code."
        },
        "settlementPaymentMethod": {
          "$ref": "#/definitions/MerchantPaymentMethodObject"
        },
        "id": {
          "type": "string",
          "example": "2ce23869-695d-4f06-b1c8-d667884f1bda",
          "description": "Auto-generated unique identifier of the merchant."
        },
        "legalName": {
          "type": "string",
          "example": "Orange Nation Gym Pty Ltd",
          "description": "The merchant's official and legally registered name."
        },
        "name": {
          "type": "string",
          "example": "The Orange Nation Gym",
          "description": "The merchant's trading name that is usually displayed at the business's physical property."
        },
        "number": {
          "type": "string",
          "example": "100000015",
          "description": "Auto-generated numeric identifier of the merchant. This identifier is merchant facing and is usually included in all communications to the merchant."
        },
        "address": {
          "description": "Merchant's address.",
          "$ref": "#/definitions/AddressObject"
        },
        "email": {
          "type": "string",
          "example": "theorangeguy@ezypay.com",
          "description": "The correspondence email of the merchant."
        },
        "phoneNumber": {
          "type": "string",
          "example": "0299998888",
          "description": "<p>The contact number of the merchant. It could be a mobile or landline number. For merchants with an Australia address, the following validation occurs: &bull; Mobile phone - Must start with 04 followed by 8 digits. &bull; Landline - Must start with 02/03/07/08 and followed by 8 digits. For merchants with a New Zealand address, the following validation occurs: &bull; Mobile phone - Must start with 02 followed by 8 digits.</p>"
        },
        "setting": {
          "description": "The setting details of the merchant.",
          "$ref": "#/definitions/MerchantSettingObject"
        },
        "organisationName": {
          "type": "string",
          "example": "Orange Nation",
          "description": "Organisation name belongs to the merchant."
        },
        "settlementSchedule": {
          "description": "The schedule for settlements.",
          "$ref": "#/definitions/SettlementScheduleObject"
        },
        "status": {
          "type": "string",
          "example": "active",
          "description": "The status of the merchant. Supported values are:<ul><li><code>inactive</code> - Merchant has been created but has not been verified by risk checking.</li><li><code>pending_risk_check</code> - Merchant is currently undergoing risk checking.</li><li><code>active</code> - Merchant has successfully passed risk checking and has full access to all functionality.</li></ul>"
        },
        "categoryCode": {
          "type": "string",
          "example": "0123",
          "description": "The merchant category classification code (MCC). A four-digit number assigned to a business by credit card companies when the business first starts accepting one of these cards as a form of payment."
        },
        "businessRegistrationNumber": {
          "type": "string",
          "example": "51824753556",
          "description": "The merchant's official business registration number."
        },
        "taxId": {
          "type": "string",
          "example": "123456782",
          "description": "The merchant's identification used for tax reporting purposes."
        },
        "website": {
          "type": "string",
          "example": "http://theorangegym.ezypay.com",
          "description": "The merchant's website address."
        },
        "description": {
          "type": "string",
          "example": "We are the Orange Gym",
          "description": "Brief additional description of the merchant."
        },
        "liveMode": {
          "type": "boolean",
          "example": true,
          "description": "Specifies if merchant account is live. Supported values are:<ul><li><code>false</code> - Merchant account is in demo mode. Merchants can create plans and subscriptions but no actual billing and payments are processed.</li><li><code>true</code> - Merchant account is in live mode. Switching to live mode will purge all previous date-sensitive data (e.g. subscriptions, invoices will be removed but not plan templates, customer details). Billing cycles will run and start charging customers.</li></ul>"
        },
        "metadata": {
          "type": "object",
          "description": "Description."
        },
        "notifications": {
          "description": "Notification setting of the merchant.",
          "$ref": "#/definitions/MerchantNotificationResult"
        }
      },
      "description": "Merchants are businesses that sign up with the Ezypay platform to manage their subscription, billing or payment needs across their customer base. Merchants may have their own membership/customer management system, and they integrate with Ezypay to help collect payments from the customers on behalf of them. Funds collected are then nett settled back to the merchants on pre-configured dates."
    },
    "InvoiceObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "3a3cd0d2-747f-4f70-9011-49f836613844",
          "description": "Auto-generated identifier of the invoice."
        },
        "documentNumber": {
          "type": "string",
          "example": "100000478",
          "description": "Auto-generated numeric identifier of the invoice. This identifier is customer facing and included in all invoicing related communications with the customer."
        },
        "date": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Issue date of the invoice. Supported format is YYYY-MM-DD."
        },
        "dueDate": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Due date of the invoice.  Supported format is YYYY-MM-DD."
        },
        "scheduledPaymentDate": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Scheduled payment date. Supported format is YYYY-MM-DD."
        },
        "status": {
          "type": "string",
          "example": "processing",
          "description": "Current state of the invoice, automated based on the associated payments or manually by merchant actions. Supported values are:<ul><li><code>paid</code> - Paid up through automated collection, manual invoicing, or marked as paid.<li><code>processing</code> -  Invoice has payment being processed.<li><code>past_due</code> - Attempt at payment collection on invoice failed.<li><code>refunded</code> - Invoice is refunded.<li><code>partially_refunded</code> - Invoice is partially refunded.<li><code>written_off</code> - Invoice has been written off and no billings will be attempted.</ul>"
        },
        "memo": {
          "type": "string",
          "description": "Memo of the invoice. Max of 100 characters."
        },
        "items": {
          "type": "array",
          "description": "Details of the individual items that are included in the invoice.",
          "items": {
            "$ref": "#/definitions/InvoiceItemObject"
          }
        },
        "amount": {
          "description": "Gross amount due for the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalRefunded": {
          "description": "Total refunded amount due for the invoice. Should not exceed total amount paid for the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "totalTax": {
          "description": "Total tax amount due for the invoice.",
          "$ref": "#/definitions/AmountObject"
        },
        "customerId": {
          "type": "string",
          "example": "05cdadcc-7d55-470f-8b47-34b5d6288ca9",
          "description": "Identifier of the customer the invoice is associated to."
        },
        "subscriptionId": {
          "type": "string",
          "description": "Identifier of the subscription the invoice is associated to."
        },
        "subscriptionName": {
          "type": "string",
          "description": "Name of the subscription the invoice is generated for."
        },
        "paymentMethodToken": {
          "type": "string",
          "example": "6419e34e-46f7-4e52-bb75-3e6541adb955",
          "description": "Auto-generated unique identifier of the payment method token for this billing schedule."
        },
        "createdOn": {
          "type": "string",
          "example": "2017-02-10",
          "description": "Created date of the invoice.  Supported format is YYYY-MM-DD."
        }
      },
      "description": "An invoice is issued by merchants to their customers and details out the services or products that were sold to the customer. Ezypay will automatically generate invoices from subscriptions at each billing cycle with a full breakdown of product items and tax, before processing payments based on the invoice payment details."
    },
    "FailedPaymentSetting": {
      "type": "object",
      "required": [
        "initialFailedPaymentAction"
      ],
      "properties": {
        "autoRebill": {
          "type": "boolean",
          "example": true,
          "description": "Flag on whether to turn on auto rebill when a failed payment has occurred."
        },
        "initialFailedPaymentAction": {
          "type": "string",
          "example": "continue",
          "description": "The initial action to perform when a failed payment has occurred. Supported values are <code>stop</code> and <code>continue</code>.",
          "enum": [
            "STOP",
            "CONTINUE"
          ]
        },
        "maximumFailedAttempts": {
          "type": "integer",
          "format": "int32",
          "example": 2,
          "description": "The maximum number of attempts to charge before billing is stopped."
        },
        "rebillDays": {
          "type": "integer",
          "format": "int32",
          "example": 7,
          "description": "Number of days before a rebill takes place. Mandatory if autoRebill is set to True.",
          "readOnly": true
        }
      }
    },
    "UpdateNoteCommand": {
      "type": "object",
      "required": [
        "message"
      ],
      "properties": {
        "message": {
          "type": "string",
          "example": "Join any Zumba class to get special discounts on Orange Fitness Apparel. Stay Orange!",
          "description": "Note's content Message. Max of 255 characters."
        }
      }
    },
    "DeletedEntityObject": {
      "type": "object",
      "properties": {
        "entityId": {
          "type": "string",
          "example": "6a72b162-f5f2-461a-be5f-4cdb3c37b553",
          "description": "Auto-generated unique identifier for the entity."
        },
        "deleted": {
          "type": "boolean",
          "example": true,
          "description": "Indicate if the entity is successfully deleted."
        }
      }
    },
    "RetryPayment": {
      "type": "object",
      "properties": {
        "oneOff": {
          "type": "boolean",
          "example": false,
          "description": "Specify if this payment method token is being used as a one-off payment. Supported values are:<ul><li><code>false</code> -  The default value. You do not need to specify the paymentMethodToken in this endpoint.<li><code>true</code> - The paymentMethodToken must be specified in the request body. Used as a one-off payment.</ul>"
        },
        "paymentMethodToken": {
          "type": "string",
          "description": "Specify the payment method token used for this on-demand payment."
        }
      }
    },
    "InvalidReasonResponseObject": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The reason a bank account or card is no longer valid for collecting payments from the customer."
        },
        "description": {
          "type": "string",
          "description": "The description of the reason a bank account or card is no longer valid for collecting payments from the customer."
        }
      }
    },
    "CreateCustomer": {
      "type": "object",
      "required": [
        "email",
        "firstName",
        "lastName"
      ],
      "properties": {
        "firstName": {
          "type": "string",
          "example": "Matt",
          "description": "Customer's first name. Max of 50 characters."
        },
        "lastName": {
          "type": "string",
          "example": "Zimmer",
          "description": "Customer's last name. Max of 50 characters."
        },
        "email": {
          "type": "string",
          "example": "matt.zimmer78@gmail.com",
          "description": "A valid unique email address that belongs to customer. Max of 255 characters."
        },
        "gender": {
          "type": "string",
          "description": "Customer gender. Supported values are <code>male</code> or <code>female</code>."
        },
        "address": {
          "description": "The customer's address object that holds address details.",
          "$ref": "#/definitions/Address"
        },
        "homePhone": {
          "type": "string",
          "example": "0294101010",
          "description": "Customer home phone number. Max of 50 characters."
        },
        "mobilePhone": {
          "type": "string",
          "example": "0426740923",
          "description": "Customer mobile phone number. Max of 50 characters."
        },
        "companyName": {
          "type": "string",
          "example": "Ezypay",
          "description": "The company name if the company is registered as a customer. Max of 100 characters."
        },
        "dateOfBirth": {
          "type": "string",
          "example": "1978-06-25",
          "description": "Customer's date of birth. Supported format is YYYY-MM-DD."
        },
        "referenceCode": {
          "type": "string",
          "example": "ME-8827",
          "description": "Reference code that can be defined by you. This can be used to store a code used by your application to identify the customer. Max of 30 characters."
        },
        "metadata": {
          "type": "object",
          "description": "Store additional data about the customer object using key/value pairs format.",
          "additionalProperties": {
            "type": "object"
          }
        }
      }
    },
    "CustomersObject": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "description": "List of search results returned.",
          "items": {
            "$ref": "#/definitions/CustomerObject"
          }
        },
        "paging": {
          "description": "Paging information.",
          "$ref": "#/definitions/Paging"
        }
      }
    },
    "UpdateMerchantSetting": {
      "type": "object",
      "required": [
        "acceptedPaymentMethods",
        "failedPaymentSetting",
        "tax",
        "timeZone"
      ],
      "properties": {
        "acceptedPaymentMethods": {
          "type": "array",
          "example": "bank",
          "description": "The supported payment method(s) that can be used to bill a customer. Supported values are <code>bank</code>, <code>mastercard</code>, <code>visa</code> and <code>amex</code>.",
          "items": {
            "type": "string"
          }
        },
        "failedPaymentSetting": {
          "description": "Settings to apply if the payment failed.",
          "$ref": "#/definitions/FailedPaymentSetting"
        },
        "tax": {
          "description": "Tax applied to all tax options under the merchant such as within invoices and plans.",
          "$ref": "#/definitions/Tax"
        },
        "timeZone": {
          "type": "string",
          "description": "Timezone that will be applied to bill customers."
        }
      }
    }
  }
}