# Retrieve By Id Account Products

Get Account Products By Id

Endpoint: GET /rest/2.0/ACCOUNT_PRODUCT/{id}
Version: 1.0
Security: JWT

## Path parameters:

  - `id` (integer, required)
    Id of the record

## Header parameters:

  - `sessionId` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.AccountId` (integer)
    AccountId

  - `retrieveResponse.Id` (string)
    ID

  - `retrieveResponse.Quantity` (string)
    Provisioned Quantity

  - `retrieveResponse.ProductId` (integer)
    Product: BillingComponent

  - `retrieveResponse.StartDate` (string)
    Start Date: The first subscription cycle will commence on the start date and renew either on the next billing date or one subscription cycle later. To enable 'co-term' behavior or to force the renewal date of this subscription product to coincide with the renewal date of existing subscriptions set the Cycle Context field to 'Sync with Service Start' and enter the desired renewal date in to 'Synchronized with Service Start Date' field.

  - `retrieveResponse.EndDate` (string)
    End Date

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Name` (string)
    Name

  - `retrieveResponse.ContractId` (integer)
    Contract: Indicates the reference contract of the product.

  - `retrieveResponse.RatingMethodId` (string)
    Rating Method

  - `retrieveResponse.RateOverride` (string)
    Rate Override

  - `retrieveResponse.RenewalDate` (string)
    Next Charge Generation Date: The date on which the system will generate fee for the next subscription cycle.

  - `retrieveResponse.AccountPackageId` (string)
    AccountPackageId: PackageId

  - `retrieveResponse.PackageProductId` (integer)
    PackageProductId

  - `retrieveResponse.Status` (string)
    Status: Indicates the status of the provisioned product. When ACTIVE, charges will be generated. If DEACTIVATED, charges will not yet be generated. Note that once charges are generated and are invoiced, the status can no longer be changed back to DEACTIVATED.

  - `retrieveResponse.TrialEndDate` (string)
    Trial End Date

  - `retrieveResponse.RenewalStartDate` (string)
    Synchronized Cycle Start Date: The start dates of new subscription cycle will be synchronized to the date entered here.

  - `retrieveResponse.ParentCustomerProductId` (integer)
    Parent Account Product

  - `retrieveResponse.RevRecContractId` (integer)
    Rev Rec Contract: This lookup field appears when the user has selected 'Existing Rev Rec Contract' for the 'Add to Rev Rec Contract' field. The user can search and select from current rev rec contracts in the system within the specific account. The account product will then be assigned to the existing rev rec contract selected.

  - `retrieveResponse.CreateNewRevRecContract` (string)
    Add to Rev Rec Contract: When provisioning or editing an account product, there are three options related to assigning the account product to a rev rec contract.Keep Unassigned:  Upon submitting the account product form, the account product will not be assigned to any rev rec contract.Create New Rev Rec Contract: Upon submitting the account product form, the system will create a new rev rec contract and assign the account product to that newly created rev rec contract.Existing Rev Rec Contract: A lookup field becomes available where the user can select an existing rev rec contract in the system to assign this account product.

  - `retrieveResponse.QuoteProductId` (integer)
    Quote Product Id

  - `retrieveResponse.QuoteId` (integer)
    Quote Id

  - `retrieveResponse.UpdateRevRecContractProduct` (string)
    Update Rev Rec Contract Product: This field determines if the update to the Account Product will trigger an update of the related active Rev Rec Contract Product. When 'No' is selected, the Account Product update will not flow through to the Rev Rec Contract Product. When 'Update and Activate Contract Change' is selected, the changes will automatically update the Rev Rec Contract Product.

  - `retrieveResponse.SfRecordId` (string)
    Salesforce Record ID

  - `retrieveResponse.SfSyncBatchId` (string)
    Salesforce Batch ID

  - `retrieveResponse.SfStatusError` (string)
    Salesforce Sync Status

  - `retrieveResponse.SfLastSync` (string)
    Salesforce Last Sync

  - `retrieveResponse.EditModifyContract` (string)
    Edit or Modify Contract: Changes can be made to rev rec contracts using different methods. This field lets the user choose if the assignment of the account product to an existing rev rec contract is an accounting contract modification or an edit of the contract that does not constitute a contract modification in accordance with accounting standards.

  - `retrieveResponse.ContractModificationDate` (string)
    Date of Contract Modification: This is the accounting date of the contract modification in accordance with accounting standards.

  - `retrieveResponse.RevRecFieldsToUpdate` (string)
    Rev Rec Contract Product Fields to Update: In some cases, users want the Rev Rec Contract Product amounts to update as a result of a change in the Account Product without updating the date fields on the Rev Rec Contract Product. This field allows the user to choose if they want all the fields on the related Rev Rec Contract Product to be updated or update fields excluding date fields.

  - `retrieveResponse.DiscountVoucherBalance` (string)
    Discount Voucher Balance

  - `retrieveResponse.BillingCycleStartDate` (string)
    Billing Cycle Start Date: Select the start date of the billing cycle to synchronize it with the subscription cycle. As a result, starting from the second charge, the subscription cycles will begin and end at the same time as the corresponding billing cycles.

  - `retrieveResponse.ContractModificationMethod` (string)
    Contract Modification Method: When 'Modify Contract' is selected, there are two methods of modification available to select.Prospective: The prospective modification method results in the rev rec contract to be early terminated and superseded by a new rev rec contract created by the system.Cumulative Catch-Up: The cumulative catch-up method results in changes in the current rev rec contract along with catch-up revenue recognition journal entries booked without a new rev rec contract being created.

  - `retrieveResponse.OrderId` (integer)
    OrderId

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error