Skip to main content

Get proration policy

GET 

https://euwest.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid

Get proration policy

Request

Path Parameters

    proration_policy_uuid UUIDrequired

    The unique identifier of a proration policy.

Responses

Success. The proration policy details are returned.

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.

Authorization: http

name: BearerTokentype: httpscheme: bearer
curl -L -X GET 'https://euwest.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://euwest.api.elasticpath.com/v2
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!