get https://secure.fusebill.com/v1/SubscriptionProducts/
This action will return a Subscription Product by its Fusebill generated ID.
Path Parameter
property | type | description |
---|---|---|
subscriptionProductId | Integer | The Fusebill generated ID that uniquely identifies this subscription product |
Examples
curl -X GET "https://secure.fusebill.com/v1/subscriptionproducts/{subscriptionProductId}" \
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//path parameter
int pathParameter = {subscriptionProductId};
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/subscriptionproducts/"+pathParameter);
//Add Content type
request.ContentType = "application/json";
request.ContentLength = 0;
//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/subscriptionProducts/{id}', headers=headers)
print(r.content)
Response
{
"subscriptionId":123061,
"planProduct":{
"status":"Active",
"productId":14934,
"planId":3273,
"productCode":"monthlycharge",
"productName":"Monthly Charge",
"productStatus":"Active",
"productDescription":null,
"productType":"RecurringService",
"productGLCode":"",
"quantity":1.0,
"maxQuantity":null,
"isRecurring":true,
"isFixed":false,
"isOptional":false,
"isIncludedByDefault":true,
"isTrackingItems":true,
"chargeAtSubscriptionActivation":true,
"orderToCashCycles":[
{
"planFrequencyId":5500,
"planProductId":22140,
"numberOfIntervals":1,
"interval":"Monthly",
"chargeModels":[
{
"chargeModelType":"Signup",
"chargeTimingType":"StartOfPeriod",
"prorationGranularity":"Daily",
"prorateOnPositiveQuantity":false,
"prorateOnNegativeQuantity":false,
"reverseChargeOnNegativeQuantity":false,
"id":653431,
"uri":null
},
{
"chargeModelType":"Lifetime",
"chargeTimingType":"Immediate",
"prorationGranularity":"Daily",
"prorateOnPositiveQuantity":false,
"prorateOnNegativeQuantity":false,
"reverseChargeOnNegativeQuantity":false,
"id":653431,
"uri":null
}
],
"remainingInterval":null,
"groupQuantityChangeCharges":false,
"planProductPriceUplifts":null,
"earningInterval":"Monthly",
"earningNumberOfIntervals":1,
"earningTimingInterval":"Daily",
"earningTimingType":"StartOfInterval",
"pricingModel":{
"pricingModelType":"Standard",
"quantityRanges":[
{
"min":0.0,
"max":null,
"prices":[
{
"amount":15.99,
"currency":"USD",
"id":653431,
"uri":null
}
],
"id":0,
"uri":null
}
],
"id":653431,
"uri":null
},
"id":653431,
"uri":null
}
],
"resetType":"Never",
"planProductUniqueId":21874,
"generateZeroDollarCharge": false,
"id":22140,
"uri":""
},
"quantity":1.0,
"isIncluded":true,
"startDate":null,
"subscriptionProductOverride":null,
"subscriptionProductPriceOverride":null,
"chargeAtSubscriptionActivation":true,
"isCharged":true,
"subscriptionProductDiscount":null,
"subscriptionProductDiscounts":[
],
"customFields":null,
"monthlyRecurringRevenue":0.0,
"netMonthlyRecurringRevenue":0.0,
"amount":15.99,
"status":"Active",
"lastPurchaseDate":"2017-01-13T22:00:06",
"earningSettings":{
"earningTimingInterval":"Daily",
"earningTimingType":"StartOfInterval"
},
"remainingInterval":null,
"groupQuantityChangeCharges":false,
"priceUpliftsEnabled":false,
"priceUplifts":[
],
"historicalPriceUplifts":[
],
"generateZeroDollarCharge": false,
"id":653431,
"uri":"https://secure.fusebill.com/v1/subscriptionproducts/653431"
}
{
"ErrorId": 0,
"HttpStatusCode": 404,
"Errors": [
{
"Key": "Api Error",
"Value": "SubscriptionProduct with id 12 not found."
}
]
}