GET v1/BillingPeriodDefinitions/GetBySubscription/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.BillingPeriodDefinition

Name	Type	Additional information
currentBillingPeriodStartDate	date	None.
currentBillingPeriodEndDate	date	None.
nextRechargeDate	date	None.
invoiceDay	integer	None.
invoiceWeekday	string	None.
invoiceMonth	integer	None.
cycle	string	None.
billingPeriodType	string	None.
createdDate	date	None.
numberOfIntervals	integer	None.
numberOfBillingPeriods	integer	None.
invoiceInAdvance	integer	None.
manuallyCreated	boolean	None.
paymentMethodId	integer	None.
autoCollect	boolean	None.
autoPost	boolean	None.
term	string	None.
poNumber	string	String length: inclusive between 0 and 255
subscriptions	ResultListOfCommon.Dto.Get.SubscriptionSummary	None.
paymentSchedules	Collection of Common.Dto.Get.BillingPeriodPaymentSchedule	None.
quickBooksLocationId	integer	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "currentBillingPeriodStartDate": "2025-05-21T08:44:13.7047108+00:00",
  "currentBillingPeriodEndDate": "2025-05-21T08:44:13.7047108+00:00",
  "nextRechargeDate": "2025-05-21T08:44:13.7047108+00:00",
  "invoiceDay": 1,
  "invoiceWeekday": "sample string 1",
  "invoiceMonth": 1,
  "cycle": "sample string 2",
  "billingPeriodType": "sample string 3",
  "createdDate": "2025-05-21T08:44:13.7047108+00:00",
  "numberOfIntervals": 4,
  "numberOfBillingPeriods": 5,
  "invoiceInAdvance": 6,
  "manuallyCreated": true,
  "paymentMethodId": 1,
  "autoCollect": true,
  "autoPost": true,
  "term": "sample string 8",
  "poNumber": "sample string 9",
  "subscriptions": {
    "headers": {
      "count": 1,
      "currentPage": 2,
      "previousPage": 3,
      "nextPage": 4,
      "maxCount": 5,
      "pageSize": 6,
      "maxPageIndex": 7,
      "sortExpression": "sample string 8",
      "sortOrder": "sample string 9",
      "additionalData": "sample string 10"
    },
    "results": [
      {
        "customerId": 1,
        "planId": 2,
        "planCode": "sample string 3",
        "name": "sample string 4",
        "description": "sample string 5",
        "reference": "sample string 6",
        "interval": "sample string 7",
        "numberOfInterval": 1,
        "subscriptionStatus": "sample string 8",
        "monthlyRecurringRevenue": 9.0,
        "netMonthlyRecurringRevenue": 10.0,
        "lastBillingDate": "2025-05-21T08:44:13.7047108+00:00",
        "nextBillingDate": "2025-05-21T08:44:13.7047108+00:00",
        "expiryDate": "2025-05-21T08:44:13.7047108+00:00",
        "scheduledActivationTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "cancellationTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "suspendedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "createdTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "modifiedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "activatedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "provisionedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "nextPeriodStartDate": "2025-05-21T08:44:13.7047108+00:00",
        "contractStartTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "contractEndTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "remainingInterval": 1,
        "migrationDate": "2025-05-21T08:44:13.7047108+00:00",
        "scheduledMigrationDate": "2025-05-21T08:44:13.7047108+00:00",
        "canMigrate": true,
        "customerFirstName": "sample string 14",
        "customerLastName": "sample string 15",
        "customerReference": "sample string 16",
        "companyName": "sample string 17",
        "customerParentId": 1,
        "primaryEmail": "sample string 18",
        "currency": "sample string 19",
        "invoiceOwner": "sample string 20",
        "invoiceOwnerId": 21,
        "geotabDevicePlanId": 1,
        "geotabDevicePlanName": "sample string 22",
        "customerIsParent": true,
        "accountingStatus": "sample string 24",
        "customerStatus": "sample string 25",
        "customerMiddleName": "sample string 26",
        "customerSuffix": "sample string 27",
        "customerTitle": "sample string 28",
        "id": 29,
        "uri": "sample string 30"
      },
      {
        "customerId": 1,
        "planId": 2,
        "planCode": "sample string 3",
        "name": "sample string 4",
        "description": "sample string 5",
        "reference": "sample string 6",
        "interval": "sample string 7",
        "numberOfInterval": 1,
        "subscriptionStatus": "sample string 8",
        "monthlyRecurringRevenue": 9.0,
        "netMonthlyRecurringRevenue": 10.0,
        "lastBillingDate": "2025-05-21T08:44:13.7047108+00:00",
        "nextBillingDate": "2025-05-21T08:44:13.7047108+00:00",
        "expiryDate": "2025-05-21T08:44:13.7047108+00:00",
        "scheduledActivationTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "cancellationTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "suspendedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "createdTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "modifiedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "activatedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "provisionedTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "nextPeriodStartDate": "2025-05-21T08:44:13.7047108+00:00",
        "contractStartTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "contractEndTimestamp": "2025-05-21T08:44:13.7047108+00:00",
        "remainingInterval": 1,
        "migrationDate": "2025-05-21T08:44:13.7047108+00:00",
        "scheduledMigrationDate": "2025-05-21T08:44:13.7047108+00:00",
        "canMigrate": true,
        "customerFirstName": "sample string 14",
        "customerLastName": "sample string 15",
        "customerReference": "sample string 16",
        "companyName": "sample string 17",
        "customerParentId": 1,
        "primaryEmail": "sample string 18",
        "currency": "sample string 19",
        "invoiceOwner": "sample string 20",
        "invoiceOwnerId": 21,
        "geotabDevicePlanId": 1,
        "geotabDevicePlanName": "sample string 22",
        "customerIsParent": true,
        "accountingStatus": "sample string 24",
        "customerStatus": "sample string 25",
        "customerMiddleName": "sample string 26",
        "customerSuffix": "sample string 27",
        "customerTitle": "sample string 28",
        "id": 29,
        "uri": "sample string 30"
      }
    ]
  },
  "paymentSchedules": [
    {
      "amount": 1.0,
      "daysDueAfterTerm": 2
    },
    {
      "amount": 1.0,
      "daysDueAfterTerm": 2
    }
  ],
  "quickBooksLocationId": 1,
  "id": 10,
  "uri": "sample string 11"
}