Add ramp line items to the cart line item

post

https://rls.congacloud.com/api/cart/v1/carts/{cartId}/items/{itemId}/auto-ramps

Creates ramp line items for the given cartId and lineItemId parameters.

Mandatory Fields:

autoRampLinesRequest.StartDate - required
autoRampLinesRequest.NoOfPeriods or autoRampLinesRequest.EndDate - at least one is required (both are required for Custom frequency)

Required Fields:

cartId (route) - required
itemId (route) - required
autoRampLinesRequest (body) - required

Responses

200 OK: ramp line items were added.
202 Accepted: the request was accepted for processing.
422 Unprocessable Entity: the request could not be processed.
500 Internal Server Error: an unexpected error occurred.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

cartId

string

required

A unique identifier of the cart

itemId

string

required

A unique identifier of the line item

Body Params

The addRampLineRequest

Request model for auto-generating ramp lines on a line item.

LineItem

object

Frequency

string | null

Billing frequency for the ramp lines (e.g. Monthly, Quarterly, Yearly, Custom).
Always required. Use 'Custom' to specify exact NoOfPeriods and EndDate together.

NoOfPeriods

int32 | null

Number of ramp periods to generate. Must be greater than 1.
Required when Frequency is not 'Custom' and EndDate is not provided.
Must be omitted when EndDate is provided for non-Custom frequencies.

StartDate

date-time | null

Start date of the first ramp period. Always required.
Must be earlier than EndDate when both are provided.

EndDate

date-time | null

End date of the last ramp period.
Required when Frequency is 'Custom' or when NoOfPeriods is not provided.
Must be later than StartDate.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

202

Accepted

500

Internal Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

422Unprocessable Content