get https://secure.fusebill.com/v1/subscriptions/
This action will return a Subscription response for a given Subscription ID. Note, setting the "PriceUpliftsEnabled" key-value to "False" from a previous value of "True" will delete existing, future and historical price uplifts.
Path Parameters
| Property | Type | Description |
|---|---|---|
subscriptionId | Integer | The Fusebill generated ID that uniquely identifies this subscription object |
Examples
curl -X GET "https://secure.fusebill.com/v1/subscriptions/{subscriptionId}" \
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//query parameter
int queryParameter = {subscriptionId};
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/subscriptions/"+queryParameter);
//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/subscriptions/{id}', headers=headers)
print(r.content)
Response
{
"customerId": 186838,
"planFrequency": {
"planRevisionId": 177229,
"numberOfIntervals": 1,
"interval": "Monthly",
"numberOfSubscriptions": 1,
"status": "Active",
"setupFees": [
],
"charges": [
],
"isProrated": false,
"prorationGranularity": null,
"planFrequencyUniqueId": 4791,
"remainingInterval": null,
"id": 4791,
"uri": null
},
"planCode": "simplemonthly",
"planName": "Simple Monthly",
"planDescription": null,
"planReference": null,
"status": "Active",
"reference": null,
"subscriptionOverride": null,
"hasPostedInvoice": true,
"createdTimestamp": "2017-04-05T17:11:10",
"activatedTimestamp": "2017-04-05T17:15:11",
"provisionedTimestamp": null,
"nextPeriodStartDate": "2017-04-10T04:00:00",
"scheduledActivationTimestamp": null,
"subscriptionProducts": [
{
"subscriptionId": 177229,
"planProduct": {
"status": "Active",
"productId": 16758,
"planId": 2804,
"productCode": "recurringmonthlyproduct",
"productName": "Recurring Monthly Product",
"productStatus": "Active",
"productDescription": null,
"productType": "RecurringService",
"productGLCode": "",
"quantity": 1,
"maxQuantity": null,
"isRecurring": true,
"isFixed": false,
"isOptional": true,
"isIncludedByDefault": false,
"isTrackingItems": false,
"chargeAtSubscriptionActivation": true,
"orderToCashCycles": [
{
"planFrequencyId": 4791,
"planProductId": 18374,
"numberOfIntervals": 1,
"interval": "Monthly",
"chargeModels": [
{
"chargeModelType": "Signup",
"chargeTimingType": "StartOfPeriod",
"prorationGranularity": "Daily",
"prorateOnPositiveQuantity": false,
"prorateOnNegativeQuantity": false,
"reverseChargeOnNegativeQuantity": false,
"id": 970993,
"uri": null
},
{
"chargeModelType": "Lifetime",
"chargeTimingType": "Immediate",
"prorationGranularity": "Daily",
"prorateOnPositiveQuantity": false,
"prorateOnNegativeQuantity": false,
"reverseChargeOnNegativeQuantity": false,
"id": 970993,
"uri": null
}
],
"remainingInterval": null,
"groupQuantityChangeCharges": false,
"planProductPriceUplifts": null,
"customServiceDateNumberOfIntervals": 1,
"customServiceDateInterval": "Periods",
"customServiceDateProjection": "Future",
"earningInterval": "Monthly",
"earningNumberOfIntervals": 1,
"earningTimingInterval": "Daily",
"earningTimingType": "StartOfInterval",
"pricingModel": {
"pricingModelType": "Standard",
"quantityRanges": [
{
"min": 0,
"max": null,
"prices": [
{
"amount": 20,
"currency": "USD",
"id": 970993,
"uri": null
}
],
"id": 0,
"uri": null
}
],
"id": 970993,
"uri": null
},
"id": 970993,
"uri": null
}
],
"resetType": "Never",
"planProductUniqueId": 18108,
"generateZeroDollarCharge": false,
"id": 18374,
"uri": ""
},
"quantity": 1,
"isIncluded": true,
"startDate": null,
"subscriptionProductOverride": null,
"subscriptionProductPriceOverride": null,
"chargeAtSubscriptionActivation": true,
"isCharged": true,
"subscriptionProductDiscount": null,
"subscriptionProductDiscounts": [
],
"customFields": null,
"monthlyRecurringRevenue": 20,
"netMonthlyRecurringRevenue": 20,
"amount": 20,
"status": "Active",
"lastPurchaseDate": null,
"earningSettings": {
"earningTimingInterval": "Daily",
"earningTimingType": "StartOfInterval"
},
"remainingInterval": null,
"groupQuantityChangeCharges": false,
"priceUpliftsEnabled": false,
"priceUplifts": [
],
"historicalPriceUplifts": [
],
"customServiceDateNumberOfIntervals": 1,
"customServiceDateInterval": "Periods",
"customServiceDateProjection": "Future",
"generateZeroDollarCharge": false,
"id": 970993,
"uri": "https://secure.fusebill.com/v1/SubscriptionProducts/970993"
}
],
"remainingInterval": null,
"remainingIntervalPushOut": null,
"openSubscriptionPeriodEndDate": "2017-04-10T04:00:00",
"chargeDiscount": null,
"setupFeeDiscount": null,
"chargeDiscounts": null,
"setupFeeDiscounts": null,
"customFields": null,
"planAutoApplyChanges": false,
"autoApplyCatalogChanges": false,
"monthlyRecurringRevenue": 20,
"netMonthlyRecurringRevenue": 20,
"amount": 20,
"contractStartTimestamp": null,
"contractEndTimestamp": null,
"expiredTimestamp":null,
"cancellationTimestamp": null,
"modifiedTimestamp": "2020-04-27T19:10:14.023",
"coupons":[
],
"invoiceDay": 1,
"invoiceMonth": null,
"canMigrate": false,
"migrationDate": null,
"scheduledMigrationDate": null,
"migrations": null,
"subscriptionHasRecurringEndOfPeriodCharge":false,
"id":122453,
"uri":"https://secure.fusebill.com/v1/subscriptions/122453"
}
{
"ErrorId": 0,
"HttpStatusCode": 404,
"Errors": [
{
"Key": "Api Error",
"Value": "Subscription with id 123 not found."
}
]
}