REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Create a credit card

post

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

Request

Path Parameters

SubscriptionNumber(required): string

The alternate identifier of the subscription.

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.
Upsert-Mode:

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

application/json

Root Schema : schema

Type: object

Show Source

AddToBillingAccountFlag: boolean

Indicates whether the party can be added as a billing account.
AuthorizedAmount: number

The amount the transaction was authorized for.
AuthRequestId: string

The card authorization request identifier.
CardHolderName: string

Title: Cardholder Name

The name of the credit card holder.
CreditCardId: integer (int64)

The unique identifier of the credit card.
CreditCardPuid: string

Maximum Length: 120

The credit card PUID.
ExpirationDate: string (date)

The credit card expiration date used for processing.
FirstName: string

The first name of the credit card holder.
InstrAssignmentId: integer (int64)

Title: Number

The instrument assignment ID associated with the credit card.
IssuerCode: string

The credit card issuing company.
LastName: string

The last name of the credit card holder.
MaskedNumber: string

The masked credit card number.
Notes: string

Title: Notes

Maximum Length: 300

The notes associated with the credit card.
PaymentSystemOrderNumber: string

The order number for the credit card payment.
RenewalCreditCardFlag: boolean

Maximum Length: 1

Indicates whether the credit card is used as Renewal Payment Method.
SubscriptionId: integer (int64)

The unique identifier of the subscription.
SubscriptionProductId: integer (int64)

The unique identifier of the subscription product.
TokenNumber: string

The credit card token number used for processing.
VoiceAuthCode: string

The credit card voice authorization information.


{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The instrument assignment ID associated with the credit card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CreditCardPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The credit card PUID.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18"
            }
        },
        "RenewalCreditCardFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18",
                "SUPPORTS_RANGE_PAGING":"true"
            }
        },
        "Notes":{
            "title":"Notes",
            "maxLength":"300",
            "type":"string",
            "description":"The notes associated with the credit card.",
            "nullable":true
        }
    }
}

Response

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 : subscriptions-creditCards-item-response

Type: object

Show Source

AddressLine1: string

Read Only: true

Maximum Length: 255

The address line 1 of the billing address.
AddressLine2: string

Read Only: true

Maximum Length: 255

The address line 2 of the billing address.
AddToBillingAccountFlag: boolean

Indicates whether the party can be added as a billing account.
AuthorizedAmount: number

The amount the transaction was authorized for.
AuthRequestId: string

The card authorization request identifier.
CardBillingAddressId: number

Read Only: true

The ID of the card billing address.
CardHolderName: string

Title: Cardholder Name

The name of the credit card holder.
CardIssuerName: string

Read Only: true

Maximum Length: 255

The name of the card issuer.
City: string

Read Only: true

Maximum Length: 255

The city of the billing address.
Country: string

Read Only: true

Maximum Length: 255

The country of the billing address.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date when the record was created.
CreditCardId: integer (int64)

The unique identifier of the credit card.
CreditCardPuid: string

Maximum Length: 120

The credit card PUID.
ExpirationDate: string (date)

The credit card expiration date used for processing.
FirstName: string

The first name of the credit card holder.
InstrAssignmentId: integer (int64)

Title: Number

The instrument assignment ID associated with the credit card.
IssuerCode: string

The credit card issuing company.
LastName: string

The last name of the credit card holder.
LastUpdateDate: string (date-time)

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login of the user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaskedNumber: string

The masked credit card number.
Notes: string

Title: Notes

Maximum Length: 300

The notes associated with the credit card.
PaymentSystemOrderNumber: string

The order number for the credit card payment.
PostalCode: string

Read Only: true

Maximum Length: 255

The postal code of the billing address.
RenewalCreditCardFlag: boolean

Maximum Length: 1

Indicates whether the credit card is used as Renewal Payment Method.
State: string

Read Only: true

Maximum Length: 255

The state of the billing address.
SubscriptionId: integer (int64)

The unique identifier of the subscription.
SubscriptionProductId: integer (int64)

The unique identifier of the subscription product.
TokenNumber: string

The credit card token number used for processing.
VoiceAuthCode: string

The credit card voice authorization information.


{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CardIssuerName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the card issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The instrument assignment ID associated with the credit card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditCardPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The credit card PUID.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The postal code of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18"
            },
            "x-queryable":true
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RenewalCreditCardFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":"18",
                "SUPPORTS_RANGE_PAGING":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":"300",
            "type":"string",
            "description":"The notes associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "CardBillingAddressId":{
            "type":"number",
            "description":"The ID of the card billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":"255",
            "type":"string",
            "description":"The city of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":"255",
            "type":"string",
            "description":"The address line 2 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":"255",
            "type":"string",
            "description":"The address line 1 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "maxLength":"255",
            "type":"string",
            "description":"The state of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"255",
            "type":"string",
            "description":"The country of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link


{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.


{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.


{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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,

...
}

Oracle Account

Oracle Account

Sign in to Cloud

REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Create a credit card

Request

Response

Default Response

Examples