Create a credit card

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : subscriptions-creditCards-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to create a subscription with credit card details by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions

Example of Request Body

The following shows the contents of the request body in JSON format.

{
   "BusinessUnitId":204,
   "LegalEntityId":204,
   "SubscriptionProfileId":300100172161474,
   "SubscriptionNumber" :"PR_Credit_Card_1",
   "PrimaryPartyId":1006,
   "InvoicingRuleId": -2,
   "BillingFrequency": "0zF",
   "TransactionTypeName": "ORA_OSS_Invoice",
   "Currency":"USD",
   "StartDate":"2019-10-01",
   "EndDate":"2019-12-31",
   "DefinitionOrganizationId":204,
   "ApprovalNote":"Test Note",
   "ShortDescription":"",
   "Description":"",
   "BillToAccountId":1006,
   "BillToSiteUseId":1025,
   "PaymentMethod":"ORA_CREDIT_CARD",
   "QuoteToContactId":2448,
   "QuoteToCcEmail":"",
   "CustomerAcceptance":"NOTREQUIRED",
   "InternalApproval":"NOTREQUIRED",
   "RenewalProcess":"MANUAL",
   "PartialPeriodType": "ORA_ACTUAL",
   "PartialPeriodStart": "ORA_SERVICE",
   "AccountingRuleId": 300100033038413,
   "PaymentTermsId": 1064,
"creditCards": [      
      {
            "TokenNumber": "9909000272777999",
            "ExpirationDate": "2021-12-31",
            "FirstName": "Cooper",
            "LastName": "Len",
            "IssuerCode": "VISA",
            "MaskedNumber": "XXXXXXXXXXXX5747"
      }
      ],
   "products":[
      {
         "LineNumber":"P1",
         "InventoryItemId":300100167848146,
         "ProductName":"QP_Item3",
         "Quantity":1,
         "GenerateBillingSchedule":"Y",
         "charges":[
            {
               "ChargeDefinition":"USAGE_CHARGESPM",
               "PriceType":"RECURRING",
               "PricePeriodicity":"0zF",
               "UnitListPrice":10,
               "ChargeName":"USAGE SPM CHARGE",
               "MeterDefinitionId":300100176337392
            },
            {
               "ChargeDefinition":"ACTIVATIONFEE",
               "PriceType":"ONE_TIME",
               "UnitListPrice":2000,
               "ChargeName":"Activation Fee"
            },
            {
               "ChargeDefinition":"MONTHLYFEE",
               "PriceType":"RECURRING",
               "UnitListPrice":200,
               "PricePeriodicity":"0zF",
               "ChargeName":"Monthly Fee"
            }
        ]
      },
      {  
         "LineNumber":"P2",
         "ProductName":"Gold Support",
         "Quantity":1,
         "coveredLevels":[  
            {  
               "LineNumber":"01",
         "Type" : "ORA_ASSET",
               "AssetName":"QP_STD4_101",
            "GenerateBillingSchedule":"Y",
               "PriceUnitOfMeasureName": "YEAR",
               "charges":[  
                  {  
                     "ChargeDefinition":"QP_SALE_PRICE",
                     "PriceType":"ONE_TIME",
                     "PricePeriodicity":"0zG",
                     "UnitListPrice":1000
                  },
                  {  
                     "ChargeDefinition":"QP_RECURRING_SALE_PRICE",
                     "PriceType":"RECURRING",
                     "PricePeriodicity":"0zG",
                     "UnitListPrice":100
                  }
               ]
            }
         ]
      }
]
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "SubscriptionId": 300100592393512,
    "SubscriptionNumber": "PR_Credit_Card_1",
    "BusinessUnitId": 204,
    "BusinessUnitName": "Vision Operations",
    "LegalEntityId": 204,
    "LegalEntityName": "Vision Operations",
    "SubscriptionProfileId": 300100172161474,
    "SubscriptionProfileName": "zOSS_SP_CalendarMonthActual_Advance_Month",
    "PrimaryPartyId": 1006,
    "PrimaryPartyName": "Computer Service and Rentals",
    "PricedOnDate": "2021-02-11T00:00:00+00:00",
    "PricingStrategyId": null,
    "PricingStrategyExplanation": null,
    "PricingSegment": null,
    "PricingSegmentExplanation": null,
    "SegmentExplanationMessage": null,
    "Currency": "USD",
    "CurrencyName": "US Dollar",
    "CurrencyConversionRate": null,
    "CurrencyConversionRateType": null,
    "CurrencyConversionRateDate": null,
    "StartDate": "2019-10-01",
    "Duration": 1,
    "Period": "0zF",
    "EndDate": "2019-12-31",
    "DefinitionOrganizationId": 204,
    "DefinitionOrganizationName": "Vision Operations",
    "PartialPeriodType": "ORA_ACTUAL",
    "PartialPeriodStart": "ORA_CALENDAR",
    "CloseReason": null,
    "ClosedDate": null,
    "CloseCreditMethod": null,
    "ApprovalNote": "Test Note",
    "CancelReason": null,
    "CanceledDate": null,
    "ApprovedDate": null,
    "RenewedDate": null,
    "ShortDescription": "",
    "Description": "",
    "Status": "ORA_DRAFT",
    "UserStatus": null,
    "BillService": "ORA_BILL",
    "BillServiceName": "Bill",
    "InvoicingRuleId": -2,
    "InvoicingRuleName": "Advance Invoice",
    "BillingDateCode": "ORA_PERIOD_START",
    "BillingDateName": "Period start",
    "BillOnDay": null,
    "BillingOffsetDays": null,
    "BillingFrequency": "0zF",
    "BillingFrequencyName": "QUARTER",
    "AccountingRuleId": 300100033038413,
    "AccountingRuleName": "3 Months, Deferred",
    "TransactionTypeName": "ORA_OSS_Invoice",
    "BillingSystem": null,
    "SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
    "CoverageInvoiceText": null,
    "BillToAccountId": 1006,
    "BillToAccountNumber": "1006",
    "BillToAccountDescription": "Computer Service and Rentals",
    "BillToSiteUseId": 1025,
    "BillToAddress": "301 Summit Hill Drive, , CHATTANOOGA, TN 37401",
    "ShipToParty": null,
    "ShipToPartyName": null,
    "ShipToPartySiteId": null,
    "ShipToSite": null,
    "PaymentMethod": "ORA_CREDIT_CARD",
    "PaymentMethodName": "Credit card",
    "PONumber": null,
    "WireNumber": null,
    "PaymentTermsId": 1064,
    "PaymentTermsName": "Immediate",
    "TaxClassificationCode": null,
    "TaxClassificationMeaning": null,
    "ExemptCertificateNumber": null,
    "ExemptReason": null,
    "ExemptReasonMeaning": null,
    "TaxExemptionHandling": "S",
    "TaxExemptionHandlingName": "Standard",
    "DocumentFiscalClassification": null,
    "CustomerAcceptance": "NOTREQUIRED",
    "InternalApproval": "NOTREQUIRED",
    "LayoutTemplate": null,
    "CommunicationChannel": null,
    "PrimarySalesPerson": null,
    "NegotiationLanguage": null,
    "QuoteToContactId": 2448,
    "EnableRenewalRemindersFlag": null,
    "RenewalProcess": "MANUAL",
    "DaysBeforeExpiry": null,
    "QuoteToCcEmail": "",
    "RenewalPricingMethodUsed": null,
    "RenewalProcessUsed": null,
    "PriceAdjustmentPercentUsed": null,
    "DaysBeforeExpiryUsed": null,
    "AssigneeId": null,
    "AssigneeType": null,
    "TotalContractValue": null,
    "EstimatedTax": null,
    "CreditedAmount": null,
    "ClosedAmount": null,
    "CanceledAmount": null,
    "InvoicedAmount": null,
    "SourceSystem": null,
    "SourceKey": null,
    "SourceNumber": null,
    "RenewalTemplateId": null,
    "NotificationTemplateId": null,
    "RenewalSubscriptionProfileId": null,
    "DefaultLanguage": null,
    "GenerateBillingSchedule": null,
    "TransactionType": "ORA_SUBSCRIPTION",
    "PricingSystem": "ORA_FUSION",
    "PricingError": null,
    "CorpCurrencyCode": "USD",
    "CurcyConvRateType": "Corporate",
    "RenewalCustomerAcceptance": null,
    "RenewalInternalApproval": null,
    "RenewalPriceAdjustmentBasis": null,
    "RenewalPriceAdjustmentPercent": null,
    "RenewalPriceAdjustmentType": null,
    "AttachmentEntityName": "OSS_DOC_SUBSCRIPTION_AGREEMENT",
    "AttachmentEntityName1": "OSS_DOC_SUPPORTING_DOCUMENTS",
    "CreatedBy": "CONMGR",
    "CreationDate": "2021-02-11T19:06:36+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-02-11T19:06:37.664+00:00",
    "LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
    "WarrantyYN": null,
    "RenewalType": null,
    "CustomerTrxTypeSequenceId": 806,
    "UsageCapture": "ORA_THIRD_PARTY",
    "LineAutonumberEnabledYn": false,
    "RenewalPaymentMethod": null,
    "RenewalPoNumber": null,
    "RenewalWireNumber": null,
    "RenewalPaymentMethodName": null,
    "UserStatusName": null,
    "RepriceFlag": null,
    "products": [
        {
            "SubscriptionProductId": 300100592393516,
            "SubscriptionId": 300100592393512,
            "LineNumber": "P1",
            "SubscriptionProductPuid": "PR_Credit_Card_1-PRDT-18094",
            "DefinitionOrganizationId": 204,
            "SubscriptionNumber": "PR_Credit_Card_1",
            "SalesProductType": "SUBSCRIPTION",
            "Description": "QP Item for SPT Subscription",
            "InventoryItemId": 300100012368232,
            "ItemUnitOfMeasure": "Ea",
            "ProductName": "QP_Item3",
            "Quantity": 1,
            "StartDate": "2019-10-01",
            "EndDate": "2019-12-31",
            "CloseReason": null,
            "CloseCreditMethod": null,
            "CancelReason": null,
            "ClosedDate": null,
            "CanceledDate": null,
            "RenewedDate": null,
            "PriceListId": null,
            "UnitPrice": null,
            "Status": "ORA_DRAFT",
            "Currency": "USD",
            "InvoicingRuleId": -2,
            "InvoicingRuleName": "Advance Invoice",
            "BillOnDay": null,
            "BillingOffsetDays": null,
            "BillingFrequency": "0zF",
            "BillingFrequencyName": "QUARTER",
            "AccountingRuleId": 300100033038413,
            "AccountingRuleName": "3 Months, Deferred",
            "TransactionTypeName": "ORA_OSS_Invoice",
            "InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "BillToAccountId": 1006,
            "BillToAccountNumber": "1006",
            "BillToAccountDescription": "Computer Service and Rentals",
            "BillToSiteUseId": 1025,
            "BillToAddress": "301 Summit Hill Drive, , CHATTANOOGA, TN 37401",
            "ShipToPartyId": null,
            "ShipToPartyName": null,
            "ShipToPartySiteId": null,
            "ShipToPartySiteName": null,
            "PaymentMethod": "ORA_CREDIT_CARD",
            "PaymentMethodName": "Credit card",
            "PONumber": null,
            "WireNumber": null,
            "PaymentTermsId": 1064,
            "PaymentTermsName": "Immediate",
            "PrePaymentNumber": null,
            "TaxExemptionHandling": "S",
            "TaxExemptionHandlingName": "Standard",
            "ExemptCertificateNumber": null,
            "ExemptReason": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TaxError": null,
            "CoverageScheduleId": null,
            "RenewalType": "RENEW",
            "BillingDateCode": "ORA_PERIOD_START",
            "BillingDateName": "Period start",
            "TotalContractValue": null,
            "EstimatedTax": null,
            "PricingError": null,
            "PriceAsOf": "2021-02-11",
            "PriceTransactionOn": "2021-02-11",
            "InvoicedAmount": null,
            "CreditedAmount": null,
            "CanceledAmount": null,
            "ClosedAmount": null,
            "SourceSystem": null,
            "SourceKey": null,
            "SourceNumber": null,
            "SourceLineKey": null,
            "SourceLineNumber": null,
            "MonthlyRecurringRevenue": null,
            "Duration": 1,
            "Period": "0zF",
            "GenerateBillingSchedule": "Y",
            "ExternalAssetKey": null,
            "ExternalParentAssetKey": null,
            "ExternalPriceListId": null,
            "ExternalRootAssetKey": null,
            "PriceListName": null,
            "NextPricingDate": null,
            "PricingTermsStartDate": null,
            "PricingTermsPricingMethod": null,
            "PricingTermsPeriod": null,
            "PricingTermsDuration": null,
            "PricingTermsAdjustmentPCT": null,
            "CorpCurrencyCode": "USD",
            "CurcyConvRateType": "Corporate",
            "AmendCreditMethod": null,
            "AmendCreditMethodName": null,
            "AmendDescription": null,
            "AmendEffectiveDate": null,
            "AmendReason": null,
            "AmendReasonName": null,
            "StatusMeaning": "Draft",
            "EnablePricingTermsFlag": null,
            "NextBillStartDate": null,
            "TaxClassificationMeaning": null,
            "CreatedBy": "CONMGR",
            "CreationDate": "2021-02-11T19:06:36.259+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2021-02-11T19:06:37.693+00:00",
            "LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
            "SummarizedBillingFlag": null,
            "InterfaceOffsetDays": null,
            "CoverageName": null,
            "SuspendReason": null,
            "SuspendedDate": null,
            "SuspendCreditMethod": null,
            "ResumeDate": null,
            "ResumeDuration": null,
            "ResumePeriod": null,
            "AutoExtendFlag": null,
            "ChurnProbability": null,
            "EarlyTerminationPenalty": null,
            "EarlyTerminationFee": null,
            "GracePeriod": null,
            "PenaltyValue": null,
            "PenaltyChargeName": "Penalty Fee",
            "EarlyTerminationPenaltyName": null,
            "ChurnPredictionTrend": null,
            "PriceAdjustmentType": null,
            "PriceAdjustmentBasis": null,
            "PriceAdjustmentPercent": null,
            "DisplaySequence": null,
            "RelatedInventoryItemId": null,
            "RelatedProductName": null,
            "ProductChangeReason": null,
            "ProductChangeSchedule": null,
            "ProductChangeScheduleFrom": null,
            "DropOneTimeChargeFlag": null,
            "RelatedProductDescription": null,
            "GenerateBillFullPeriodFlag": null,
            "RenewalPaymentMethod": null,
            "RenewalPoNumber": null,
            "RenewalWireNumber": null,
            "RenewalPaymentMethodName": null,
            "CustomerTrxTypeSequenceId": 806,
            "RepriceFlag": null,
            "AlignBillingFrom": null,
            "PendingActivationFlag": null,
            "charges": [
                {
                    "BillLineId": null,
                    "ChargeDefinition": "USAGE_CHARGESPM",
                    "ChargeId": 300100592393517,
                    "ChargePuid": "PR_Credit_Card_1-PRDT-18094-CHRG-17127",
                    "CoveredLevelId": null,
                    "PrePaymentNumber": null,
                    "PricePeriodicity": "0zF",
                    "PriceType": "RECURRING",
                    "RollupFlag": false,
                    "SequenceNumber": null,
                    "SubscriptionId": 300100592393512,
                    "SubscriptionProductId": 300100592393516,
                    "ChargeName": "USAGE SPM CHARGE",
                    "ExternalKey": null,
                    "ExternalParentKey": null,
                    "UnitListPrice": 10,
                    "Allowance": null,
                    "BlockSize": null,
                    "TieredFlag": null,
                    "TierType": null,
                    "UsagePriceLockFlag": null,
                    "PricePeriodicityName": "QUARTER",
                    "ChargeDefinitionName": null,
                    "ServiceId": null,
                    "CreatedBy": "CONMGR",
                    "CreationDate": "2021-02-11T19:06:36.362+00:00",
                    "LastUpdateDate": "2021-02-11T19:06:37.542+00:00",
                    "LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
                    "LastUpdatedBy": "CONMGR",
                    "MeterDefinitionId": null,
                    "MeterId": null,
                    "InitialMeterReadingId": null,
                    "AggregationMethod": null,
                    "AssetMeterYn": null,
                    "TrueUpPeriod": "ORA_OSS_USAGE_BILLING_PERIOD",
                    "TrueUpPeriodName": "Billing period",
                    "EstimatedAmount": null,
                    "EstimatedMethodName": "None",
                    "EstimatedQuantity": null,
                    "EstimationMethod": "ORA_OSS_USAGE_EST_NONE",
                    "MinimumAmount": null,
                    "MinimumQuantity": null,
                    "InvoicingRuleId": -2,
                    "InvoicingRuleName": "Advance Invoice",
                    "PeriodicBillingFlag": null,

...
} 
Back to Top