Supported response attributes

Response Field	Format	Description
id	String	The unique identifier assigned to the subscription by the channel. This is the identifier that should be used in subsequent subscription API calls.
creationDate	String	The date on which the subscripton was created.
endDate	String	The end date for the subscription (e.g., in the case of a contract); may be NULL.
externalAccountId	String	The identifier for the external (to the channel) account.
status	String Enum	The status of the subscription order; can be INITIALIZED, PENDING_USER_APPROVAL, PENDING_REMOTE_CREATION, FREE_TRIAL, ACTIVE, FINISHED, ONE_TIME, CANCELLED, SUSPENDED, FREE_TRIAL_EXPIRED, FREE_TRIAL_CANCELLED, DELETED, FAILED, UPCOMING, PENDING_MIGRATION_ACTIVATION.
maxUsers	Numeric	The maximum number of users allowed for the subscription.
order	Object	The order information for the subscription that was created.
order.paymentPlanId	String	The unique identifier for the edition pricing for which a subscription is being created.
order.discountId	String	The unique identifier for the discount to be applied to the subscription.
order.activated	boolean	True if the subscription has been activated.
order.paymentPlan	Object	An object representing the payment plan for this subscription.
paymentPlan.id	String	The identifier for the payment plan created by the channel.
paymentPlan.href	String	The link to the payment plan.
paymentPlan.uuid	String	The unique identifier for the payment plan.
paymentPlan.frequency	String	The frequency of billing; may be ONE_TIME, MONTHLY, QUARTERLY, SIX_MONTHS, YEARLY, TWO_YEARS, THREE_YEARS, or DAILY.
paymentPlan.contract	Object	An object containing contract information for the payment plan.
contract.minimumServiceLength	Numeric	The minimum service length specified by the contract.
contract.cancellationPeriodLimit	Numeric	The cancellation period limit specified by the contract.
contract.endOfContractGracePeriod	Numeric	The grace period allowed at the end of the contract.
contract.blockSwitchToShorterContract	Boolean	True if the contract blocks changing to a shorter contract.
contract.blockContractDowngrades	Boolean	True if the contract blocks contract downgrades.
contract.blockContractUpgrades	Boolean	True if the contract blocks contract upgrades.
contract.autoExtensionPricingId	Numeric	The identifier for the pricing plan for the contract autoextension, if applicable.
contract.gracePeriod	Object	An object representing the contract grace period.
gracePeriod.length	Numeric	The length of the grace period specified by the contract.
gracePeriod.unit	String	The units for the grace period length specified by the contract.
contract.terminationFee	Object	An object representing the contract termination fee.
terminationFee.type	String Enum	The termination fee type; can be NONE, PERCENTAGE, or FLAT_RATE.
terminationFee.description	String	The termination fee description.
terminationFee.percentageFee	Numeric	The percentage to charge for the termination fee.
terminationFee.flatFee	Object	An object representing the flat fee to charge for the termination fee; this will contain an entry for each supported currency for the product.
paymentPlan.allowCustomUsage	Boolean	True if custom usage is allowed for the subscription.
paymentPlan.keepBillDateOnUsageChange	Boolean	True if the billling date doesn't change on usage changes to the subscription.
paymentPlan.separatePrepaid	Boolean	True if prepayment is separate.
paymentPlan.isPrimaryPrice	Boolean	True if this is the primary price for the subscription.
paymentPlan.costs	Array	An array of objects containing cost information.
costs.cost	Object	An object containing cost information.
cost.amount	Object	An object representing the cost amount; this will contain an entry for each supported currency for the product.
cost.pricePerIncrement	Boolean	True if the price applies per increment.
cost.blockContractDecrease	Boolean	True if the contract blocks a contract decrease in cost.
cost.blockContractIncrease	Boolean	True if the contract blocks a contract increase in cost.
cost.blockOriginalContractDecrease	Boolean	True if the contract blocks a decrease in cost from the original contract.
cost.unit	String Enum	The unit for the contract cost. See orderLine.unit for valid units.
cost.unitDependency	String	The unit dependency for the contract cost.
cost.minUnits	Numeric	The minimum units allowed.
cost.maxUnits	Numeric	The maximum units allowed.
cost.meteredUsage	Boolean	True if the cost is for metered usage.
cost.increment	Numericm	The increment the cost applies to.
paymentPlan.discount	Object	An object containing the discount information.
discount.amount	Object	An object representing the discount amount; this will contain an entry for each supported currency for the product.
discount.description	String	The discount description.
discount.percentage	Numeric	The percentage discount.
discount.numOfBillingCycles	Numeric	The number of billing cycles the discount applies to.
discount.availableRedemptions	Numeric	The number of times remaining the discount can be applied.
discount.startDate	String	The start date of the discount.
discount.expirationDate	String	The expiration date of the discount.
order.contract	Object	An object representing the contract for this subscription, if applicable.
contract.minimumServiceLength	Numeric	The minimum service length specified by the contract.
contract.cancellationPeriodLimit	Numeric	The cancellation period limit specified by the contract.
contract.endOfContractGracePeriod	Numeric	The grace period allowed at the end of the contract.
contract.endOfContractDate	String	The end date of the contract.
contract.gracePeriodEndDate	String	The end date of the contract grace period.
contract.terminationFee	Object	An object representing the contract termination fee.
terminationFee.type	String Enum	The termination fee type; can be NONE, PERCENTAGE, or FLAT_RATE.
terminationFee.description	String	The termination fee description.
terminationFee.percentage	Numeric	The percentage to charge for the termination fee.
terminationFee.price	Object	An object representing the flat fee price to charge for the termination fee; this will contain an entry for each supported currency for the product.
contract.renewal	Object	An object representing the contract renewal.
renewal.order	String	A link to the contract renewal rder.
renewal.paymentPlan	String	TA link to the contract renewal payment plan.
order.previousOrder	String	A link to the previous order.
order.nextOrder	String	A link to the next order.
order.discount	String	A link to the discount.
order.orderLines	Array	An array of orderLine objects representing the subscription information. This information is required in cases where additional information is required by the edition. An example of this would be an edition that has individual unit pricing ("price per unit"), so information about the desired number of units must be passed.
orderLines.orderLine	Object	An object containing information about one line of the subscription order.
orderLine.type	String Enum	The type of order line item; can be ITEM, TAX, PENALTY, or DISCOUNT.
orderLine.unit	String Enum	The unit type of order line item; can be USER, GIGABYTE, MEGABYTE, HOUR, MINUTE, INVOICE, UNIT, PROJECT, PROPERTY, ITEM, WORD, EMAIL, CONTACT, CALL, CREDIT, ROOM, HOST, AGENT, OPERATOR, PROVIDER, MANAGER, TESTER, JVM, SERVER, WEB_USE_MINUTE, AUDIO_USE_MINUTE, PIECE, EMPLOYEE_PAY_PERIOD, COMPUTER, NOT_APPLICABLE, ONE_TIME_SETUP, DATA_POINTS, TIER1_API_CALLS, TIER2_API_CALLS, ADVISORY_HOURS, OVERAGE_AUDIO_MINUTE, EMPLOYEE, CONNECTION, PUSH_USER, THOUSAND_EMAILS_PER_DAY, PUSH_NOTIFICATION_DEVICES, API_CALLS, SMS_TEXT_MESSAGE, CONTACTS_1000, CONTRACT_FEE, TRANSFER_FEE, REACTIVATION_FEE, RECIPIENT, ADDITIONAL_1000_CONTACTS_BLOCK, SCHEDULE_PLAN, EMAILS_1000, MOBILE_DEVICE, PAYSLIP, PAYSLIP_CORRECTION, STORE, WEBSITE, EPAPER, PAGE, POSTAGE_AND_PRINT, INTERNATIONAL_POSTAGE_AND_PRINT, TIER1_TOP_LEVEL_DOMAIN, TIER2_TOP_LEVEL_DOMAIN, DEDICATED_IP, ENABLELCM, MAXCOMPONENTS, DATA_MANAGEMENT_USER, SPECIALIST_USER, PROFESSIONAL_USER, MATERIALITY_MATRIX, STAKEHOLDER_MANAGEMENT, SCORECARD, STANDARD_MAPPING, DONATION_MANAGEMENT, DOCUMENT, PACKAGE_SMALL, PACKAGE_LARGE, MEMBER, ATTENDEE, MAILING, RESPONSE, EXTERNAL_INVOICE_FEE, CLIENT_TEST, IMAGE_TRANSFORMATION, TOTAL_IMAGE, LICENSE, MAILBOX, FREE_40_INCH_HDTV_PC, FREE_46_INCH_HDTV_PC, FREE_46_INCH_HDTV_PC_MOUNTING, EMPLOYEE_PER_WEEK, REGISTER, END_USER, CORE, DEVICE, PORT, MEASURER, PUBLISHED_MEASUREMENT, NODE, SERVER_RULE, VPN_LP, PROXY_LP, DESKTOP_CONNECT_LP, CAMERA, MAIN_SOUND_ZONE, SUB_SOUND_ZONE, POST, REPORT, BOX, SESSION, DISPLAY, TRUCKROLL, TRANSACTION_FEE, SENDING_API_CALL, LOOKUP_API_CALL, or ANALYTICS_API_CALL.
orderLine.quantity	Numeric	The quantity for order line item.
orderLine.price	Numeric	The price per unit for order line item.
orderLine.percentage	Numeric	The percentage (e.g., tax) associated with order line item.
orderLine.totalPrice	Numeric	The total price for order line item.
orderLine.description	String	The description of order line item.
order.oneTimeOrders	Array	An array of any one time order listings.
oneTimeOrders.oneTimeOrder	Object	An object representing a one time order.
oneTimeOrder.paymentPlan	String	A link to the payment plan for the one time order.
oneTimeOrder.id	String	The one time order provided by the channel.
oneTimeOrder.startDate	String	The one time order start date.
oneTimeOrder.endDate	String	The one time order end date.
oneTimeOrder.nextBillingDate	String	The next billing date for the one time order.
oneTimeOrder.endOfDiscountDate	String	The end date for the one time order discount, if applicable.
oneTimeOrder.status	String Enum	The status of the subscription order; can be INITIALIZED, PENDING_USER_APPROVAL, PENDING_REMOTE_CREATION, FREE_TRIAL, ACTIVE, FINISHED, ONE_TIME, CANCELLED, SUSPENDED, FREE_TRIAL_EXPIRED, FREE_TRIAL_CANCELLED, DELETED, FAILED, UPCOMING, PENDING_MIGRATION_ACTIVATION.
oneTimeOrder.frequency	String	The frequency of billing, in this case ONE_TIME.
oneTimeOrder.currency	String	The currency for the one time order; may be USD, CAD, EUR, JPY, GBP, KRW, CHF, SEK, SGD, MYR, AUD, MXN, INR, BRL, DKK, NZD, NOK, ZAR, PHP
oneTimeOrder.type	String	The subscription type for the one time order; may be NEW, MIGRATION, ADOPTION, METERED_USAGE, FREE_TRIAL_ACTIVATION, BUNDLED, TERMINATION_FEE, END_OF_CONTRACT_MIGRATION, REFUND, CREDIT, ONE_TIME_FEE, ADDITIONAL_FEE.
oneTimeOrder.totalPrice	Numeric	The total price of the one time order.
oneTimeOrder.user	String	A link to the user to which the one time order is associated.
oneTimeOrder.salesSupportUser	String	A link to the sales support user to which the one time order is associated.
oneTimeOrder.company	String	A link to the company to which the one time order is associated.
order.parameters	Array	An array of optional parameters required in order to create a subscription to a product. Some products will require additional information that can be passed through this attribute.
parameters.name	String	The name of the parameter to be passed.
parameters.value	String	The value of the parameter to be passed.