Get all billing profiles
get
/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles
Request
Path Parameters
-
SubscrAccountNumber(required): string
The alternate unique identifier of the subscription account.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- BillingProfileNumberRF: Finds a billing profile with the specified user key.
Finder Variables:- BillingProfileNumber; string; The alternate unique identifier of the billing profile.
- PrimaryKey: Finds a billing profile with the specified primary key.
Finder Variables:- BillingProfileId; integer; The unique identifier of the billing profile.
- BillingProfileNumberRF: Finds a billing profile with the specified user key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AddrElementAttribute1; string; The additional address element to support flexible address format.
- AddrElementAttribute2; string; The additional address element to support flexible address format.
- AddrElementAttribute3; string; The additional address element to support flexible address format.
- AddrElementAttribute4; string; The additional address element to support flexible address format.
- AddrElementAttribute5; string; The additional address element to support flexible address format.
- AddressLine1; string; The first line of the identifying address.
- AddressLine2; string; The second line of the identifying address.
- AddressLine3; string; The third line of the identifying address.
- AddressLine4; string; The fourth line of the identifying address.
- AddressLinesPhonetic; string; The phonetic or Kana representation of the Kanji address lines (used in Japan).
- BillCycle; integer; Indicates when the bill cycle occurs.
- BillCycleDay; integer; The day on which the bill cycle occurs.
- BillLanguage; string; The language that is used in an invoice.
- BillMedia; string; The media used to generate a bill for a billing profile.
- BillingAccountNumber; string; The billing account number of the profile.
- BillingEmailAddress; string; The email address of the billing profile.
- BillingFrequency; string; The interval in which customer is billed for a service.
- BillingProfileId; integer; The unique identifier of the billing profile.
- BillingProfileName; string; The name of the billing profile.
- BillingProfileNumber; string; The unique user key for the table.
- BillingType; string; The billing type for a billing profile.
- Building; string; The specific building name or number of a given address.
- City; string; The city of the identifying address.
- CollectionsFlag; boolean; The amount collected when users have not paid their bills for some time, and a collection process has been initiated.
- Comments; string; The additional comments for billing profile.
- CorpCurrencyCode; string; The application composer extensibility schema field.
- Country; string; The country of the identifying address.
- County; string; The county of the identifying address.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date and time when the row was created.
- CurcyConvRateType; string; The application composer extensibility schema field.
- CurrencyCode; string; The application composer extensibility schema field.
- ExternalBillingAccount; string; The external billing account number.
- FloorNumber; string; The specific floor number at a given address or in a particular building when the building number is provided.
- IdenAddrLocationId; integer; The unique identifier of the location of the identifying address.
- InvoiceByEmailFlag; boolean; Indicates whether an electronic copy of the invoice is preferred.
- InvoiceByMailFlag; boolean; Indicates whether a paper copy of the invoice is preferred.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdateLogin; string; The login of the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the row.
- PaymentMethod; string; The method of payment used for a billing profile.
- PostalCode; string; The postal code of the identifying address.
- PostalPlus4Code; string; The four digit extension to the United States Postal ZIP code.
- PrepaidAutomaticTopupFlag; boolean; Indicates whether the customer requires a prepaid automatic top up for a billing profile.
- PrepaidSMSNotificationFlag; boolean; Indicates whether the customer requires a short message service notification for a prepaid billing profile.
- PrimaryFlag; boolean; Indicate whether the billing profile is the primary billing profile for the subscription account.
- Province; string; The province of the identifying address.
- State; string; The state of the identifying address.
- StatementFlag; boolean; Indicates whether the customer requires a statement for the billing profile.
- Status; string; The status of a billing profile.
- SubscrAccountNumber; string; The unique user key of the subscription account.
- SubscriptionAccountId; integer; The unique identifier of the subscription account.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionAccounts-billingProfiles
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): 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(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-billingProfiles-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line of the identifying address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line of the identifying address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line of the identifying address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the identifying address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
BillCycle: integer
(int64)
Title:
Bill Cycle
Minimum Value:0
Indicates when the bill cycle occurs. -
BillCycleDay: integer
(int32)
Title:
Bill Cycle Day
Minimum Value:1
Maximum Value:31
The day on which the bill cycle occurs. -
BillingAccountNumber: string
Title:
Billing Account Number
Maximum Length:30
The billing account number of the profile. -
BillingEmailAddress: string
Title:
Email Address
Maximum Length:100
The email address of the billing profile. -
BillingFrequency: string
Title:
Billing Frequency
Maximum Length:100
The interval in which customer is billed for a service. -
BillingProfileId: integer
(int64)
Title:
Billing Profile ID
Read Only:true
The unique identifier of the billing profile. -
BillingProfileName: string
Title:
Name
Maximum Length:30
The name of the billing profile. -
BillingProfileNumber: string
Title:
Billing Profile Number
Maximum Length:30
The unique user key for the table. -
BillingType: string
Title:
Billing Type
Maximum Length:100
The billing type for a billing profile. -
BillLanguage: string
Title:
Language
Maximum Length:30
The language that is used in an invoice. -
BillMedia: string
Title:
Bill Media
Maximum Length:100
The media used to generate a bill for a billing profile. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number of a given address. -
City: string
Title:
City
Maximum Length:60
The city of the identifying address. -
CollectionsFlag: boolean
Title:
Collections
Maximum Length:1
Default Value:false
The amount collected when users have not paid their bills for some time, and a collection process has been initiated. -
Comments: string
Title:
Comments
Maximum Length:255
The additional comments for billing profile. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The application composer extensibility schema field. -
Country: string
Title:
Country
Maximum Length:2
The country of the identifying address. -
County: string
Title:
County
Maximum Length:60
The county of the identifying address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The application composer extensibility schema field. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The application composer extensibility schema field. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the billing profile can be deleted. -
ExternalBillingAccount: string
Title:
External Billing Account Number
Maximum Length:30
The external billing account number. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address of the identifying address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The multiline formatted address of the identifying address. -
IdenAddrLocationId: integer
(int64)
Title:
Location ID
The unique identifier of the location of the identifying address. -
InvoiceByEmailFlag: boolean
Title:
Email Invoice
Maximum Length:1
Default Value:false
Indicates whether an electronic copy of the invoice is preferred. -
InvoiceByMailFlag: boolean
Title:
Mail Invoice
Maximum Length:1
Default Value:false
Indicates whether a paper copy of the invoice is preferred. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentMethod: string
Title:
Payment Method
Maximum Length:100
The method of payment used for a billing profile. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the identifying address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrepaidAutomaticTopupFlag: boolean
Title:
Prepaid Automatic Top Up
Maximum Length:1
Default Value:false
Indicates whether the customer requires a prepaid automatic top up for a billing profile. -
PrepaidSMSNotificationFlag: boolean
Title:
Prepaid SMS Notification
Maximum Length:1
Default Value:false
Indicates whether the customer requires a short message service notification for a prepaid billing profile. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicate whether the billing profile is the primary billing profile for the subscription account. -
Province: string
Title:
Province
Maximum Length:60
The province of the identifying address. -
State: string
Title:
State
Maximum Length:60
The state of the identifying address. -
StatementFlag: boolean
Title:
Statement
Maximum Length:1
Default Value:false
Indicates whether the customer requires a statement for the billing profile. -
Status: string
Title:
Status
Maximum Length:30
The status of a billing profile. -
SubscrAccountNumber: string
Title:
Subscription Account Number
Read Only:true
Maximum Length:30
The unique user key of the subscription account. -
SubscriptionAccountId: integer
(int64)
Title:
Subscription Account ID
The unique identifier of the subscription account. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the record can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.