Partner Endpoints

partner/billing-packages

Changed on

This endpoint is used to retrieve the list of billing packages that you can assign to an account.

get/partner/billing-packages

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/billing-packages
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Limitinteger

Maximum number of billing packages to return

Countrystring

Filter billing packages by country abbreviation (e.g. CA, US)

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "BillingPackages": {
    "0": {
      "PackageName": "Enterprise Billing Package",
      "DateAdded": "2019-11-03 01:00:00",
      "CreatedBy": "ABC Partner",
      "Currency": "CAD"
    }
  }
}

Changes

    • info

      added the new optional query request parameter Country

    • info

      added the new optional query request parameter Limit