get https://secure.fusebill.com/v1/BillingPeriodDefinitions/
This call is used to return the detailed information for an existing billing period definition.
Path Parameters
Property | Type | Description |
---|---|---|
billingPeriodDefinitionId | Integer | The Fusebill generated ID that uniquely identifies the billing period definition |
Examples
curl -X GET "https://secure.fusebill.com/v1/BillingPeriodDefinitions/{billingPeriodID}\
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/BillingPeriodDefinitions/{billingPeriodID}");
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic " + apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
result = streamReader.ReadToEnd();
}
#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/BillingPeriodDefinitions/{billingPeriodID}', headers=headers)
print(r.content)
Response
{
"currentBillingPeriodStartDate": "2019-10-29T04:00:00",
"currentBillingPeriodEndDate": "2020-01-29T05:00:00",
"nextRechargeDate": "2020-01-29T05:00:00",
"invoiceDay": 29,
"invoiceMonth": null,
"cycle": "Monthly",
"billingPeriodType": "CustomerActivation",
"createdDate": "2019-10-29T04:02:33",
"numberOfIntervals": 3,
"numberOfBillingPeriods": 3,
"invoiceInAdvance": 0,
"manuallyCreated": false,
"paymentMethodId": null,
"autoCollect": null,
"autoPost": null,
"term": "",
"poNumber":"234-UPRC",
"subscriptions": {
"headers": {
"count": 1,
"currentPage": 0,
"previousPage": -1,
"nextPage": 1,
"maxCount": 6,
"pageSize": 10000,
"maxPageIndex": 1,
"sortExpression": "planCode",
"sortOrder": "Ascending",
"additionalData": null
},
"results": [
{
"customerId": 593500,
"planId": 17126,
"planCode": "bronze",
"name": "Bronze",
"description": null,
"reference": null,
"interval": "Monthly",
"numberOfInterval": 3,
"subscriptionStatus": "Active",
"monthlyRecurringRevenue": 500,
"netMonthlyRecurringRevenue": 500,
"lastBillingDate": "2019-10-29T04:00:00",
"nextBillingDate": "2020-01-29T05:00:00",
"expiryDate": null,
"scheduledActivationTimestamp": null,
"cancellationTimestamp": null,
"suspendedTimestamp": null,
"createdTimestamp": "2019-07-29T19:44:14",
"modifiedTimestamp": "2019-10-29T14:30:40.32",
"activatedTimestamp": "2019-07-29T19:45:11",
"provisionedTimestamp": null,
"nextPeriodStartDate": "2020-01-29T05:00:00",
"contractStartTimestamp": null,
"contractEndTimestamp": null,
"remainingInterval": null,
"migrationDate": null,
"scheduledMigrationDate": null,
"canMigrate": true,
"id": 300554,
"uri": "https://secure.fusebill.com/v1/subscriptions/300554"
}
]
},
"id": 227787,
"uri": "https://secure.fusebill.com/v1/BillingPeriodDefinitions/227787"
}
{
"ErrorId": 0,
"HttpStatusCode": 404,
"Errors": [
{
"Key": "Api Error",
"Value": "BillingPeriodDefinition with id 82 not found."
}
]
}