Create a Proration Policy

POST 
/subscriptions/proration-policies

In Subscriptions, you configure proration by creating a proration policy and attaching it to an offering. Once you have attached the policy, the proration policy applies to all subscriptions that use the offering.

Request

application/json

Body

data ProrationPolicyCreaterequired

type ProrationPolicyType (string)required

Possible values: [subscription_proration_policy]

attributes ProrationPolicyAttributesrequired

name stringrequired

Possible values: >= 3 characters and <= 1024 characters

A name for the proration policy.

rounding stringrequired

Possible values: [up, down, nearest]

When rounding in proration, you must decide how to round the units of time used to calculate the charges.

• round up to the next unit, ensuring subscribers are charged slightly more to cover any partial use.
• round down to the previous whole unit, providing subscribers with a slight benefit by not charging for partial use.
• round to the nearest whole unit, whether up or down, based on standard rounding rules. For example, rounding 0.5 up and rounding 0.5 down.

external_ref ExternalRef (string)

Possible values: <= 2048 characters

A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

Responses

201

Success. The proration policy is created.

application/json

Schema

Schema

data ProrationPolicy

id UUID (string)

The unique identifier.

type ProrationPolicyType (string)required

Possible values: [subscription_proration_policy]

attributes ProrationPolicyAttributesrequired

name stringrequired

Possible values: >= 3 characters and <= 1024 characters

A name for the proration policy.

rounding stringrequired

Possible values: [up, down, nearest]

When rounding in proration, you must decide how to round the units of time used to calculate the charges.

• round up to the next unit, ensuring subscribers are charged slightly more to cover any partial use.
• round down to the previous whole unit, providing subscribers with a slight benefit by not charging for partial use.
• round to the nearest whole unit, whether up or down, based on standard rounding rules. For example, rounding 0.5 up and rounding 0.5 down.

external_ref ExternalRef (string)

Possible values: <= 2048 characters

A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

meta ProrationPolicyMetarequired

owner stringrequired

The owner of a resource, either store or organization.

timestamps Timestampsrequired

updated_at stringrequired

The date and time a resource was updated.

created_at stringrequired

The date and time a resource was created.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "subscription_proration_policy",
    "attributes": {
      "name": "Main Policy",
      "rounding": "up",
      "external_ref": "abc123"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Loading...