Jump to

• Request
• Response
• Examples

Resume a subscription product

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/resume

This method lets you resume a suspended subscription product.

Request

Path Parameters

• SubscriptionProductPuid(required): string
  The public unique identifier of the subscription product.

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• autoExtendFlag: boolean
• resumeDate: string (date)
• resumeDuration: number
• resumePeriod: string

{
    "type":"object",
    "properties":{
        "resumePeriod":{
            "type":"string",
            "nullable":true
        },
        "resumeDuration":{
            "type":"number",
            "nullable":true
        },
        "autoExtendFlag":{
            "type":"boolean",
            "nullable":true
        },
        "resumeDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  204 response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"204 response."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows to resume a subscription product 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/subscriptionProducts/CDRM_1001-PRDT-1004

Example of Request Payload

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

{
       "name" : "resume", 
       "parameters": [ 
                      {
                        "resumeDate":"2019-07-15"
                       } 
                     ] 
     }

Example of Response Body

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

{
  "result": "Success"
}

Back to Top