List the Recurring billing records of subscription product line.
get
/ccstore/v1/selfservice/subscriptionProducts/{subscriptionProductPuId}/billLines
List the Recurring billing records of subscription product line. It'll not list the one time charges
Request
Supported Media Types
- application/json
Path Parameters
-
subscriptionProductPuId(required): string
ID of subscription product.
Query Parameters
-
limit: string
The batch size of the subscription products lines to be fetched together. Default limit is 25, max limit is also 25
-
offset: string
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
It is to short the result based on a field (if sorting based on that field is supportred by fusion). Default is InvoiceDate.
Response
Supported Media Types
- application/json
200 Response
Response containing the list of billing records of subscription product line
Root Schema : getSubscriptionProductBillLines_Response
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items:
array Items
Title:
Items
The items in the collection. -
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset value used in the current page.
-
totalResults:
integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Example:
{
"offset":0,
"count":14,
"hasMore":false,
"limit":25,
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/BIQA_OTBI_SM5-PRDT-8012/billLines"
}
],
"items":[
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"0",
"Amount":"2000",
"DateBilledTo":"2020-05-31",
"ChargeName":"Activation Fee",
"PricedQuantity":null,
"ListPrice":"2000",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8023"
},
"TransactionAmount":"2400",
"DateBilledFrom":"2019-01-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8023"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"1",
"Amount":"200",
"DateBilledTo":"2019-01-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8025"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-01-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8025"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"2",
"Amount":"200",
"DateBilledTo":"2019-02-28",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8030"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-02-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8030"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"3",
"Amount":"200",
"DateBilledTo":"2019-03-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8035"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-03-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8035"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"4",
"Amount":"200",
"DateBilledTo":"2019-04-30",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8040"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-04-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8040"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"5",
"Amount":"200",
"DateBilledTo":"2019-05-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8045"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-05-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8045"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"6",
"Amount":"200",
"DateBilledTo":"2019-06-30",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8050"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-06-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8050"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"7",
"Amount":"200",
"DateBilledTo":"2019-07-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8055"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-07-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8055"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"8",
"Amount":"200",
"DateBilledTo":"2019-08-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8060"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-08-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8060"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"9",
"Amount":"200",
"DateBilledTo":"2019-09-30",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8065"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-09-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8065"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"10",
"Amount":"200",
"DateBilledTo":"2019-10-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8070"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-10-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8070"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"11",
"Amount":"200",
"DateBilledTo":"2019-11-30",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8075"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-11-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8075"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"12",
"Amount":"200",
"DateBilledTo":"2019-12-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8080"
},
"TransactionAmount":"240",
"DateBilledFrom":"2019-12-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8080"
},
{
"InvoiceBillLineId":null,
"TransactionNumber":"4",
"BillingPeriod":"13",
"Amount":"200",
"DateBilledTo":"2020-01-31",
"ChargeName":"Monthly Fee",
"PricedQuantity":null,
"ListPrice":"200",
"@context":{
"headers":{
"ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"key":"BIQA_OTBI_SM5-PRDT-8012-BILL-8085"
},
"TransactionAmount":"240",
"DateBilledFrom":"2020-01-01",
"InvoiceDate":"2020-01-23",
"BillLinePuid":"BIQA_OTBI_SM5-PRDT-8012-BILL-8085"
}
]
}
Nested Schema : items
Type:
Show Source
object
-
Amount:
number
Title:
Amount
The amount for which the bill is generated. -
BillingPeriod:
number
Title:
Sequence
The period for which the bill is generated. -
BillLinePuid:
string
Maximum Length:
120
The public unique identifier of the bill line. -
ChargeName:
string
Title:
Charge Name
Maximum Length:120
The name of the charge associated with the bill line. -
DateBilledFrom:
string(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo:
string(date)
Title:
Bill-to Date
The date up to which the bill is generated. -
InvoiceBillLineId:
integer(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate:
string(date)
The date when the invoice was raised.
-
ListPrice:
number
The list price of the product associated with the bill line.
-
PricedQuantity:
number
The quantity for which the bill line was charged.
-
TransactionAmount:
number
Title:
Invoice Amount
The amount for which the transaction occurred. -
TransactionNumber:
string
Title:
Invoice Number
Maximum Length:30
The number of the transaction.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|59000|If there is a missing required property.|
|59002|If request can't be processed currently.|
|59003|If there is any invalid path parameter|
|59004|If resource is not found|
|59005|If error occurred while processing input.|
|59008|If any issue occurred while triggering the fusion|
|59010|If self service is not enabled|
Root Schema : Error
Type:
Show Source
object
-
message:
string
The error message
-
status:
string
The Error code