Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyRecurrencePoliciesByIDRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    delete get head post

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { ID: string; projectKey: string };
    }

    Methods

    • Deletes a Recurrence Policy in the Project.

      A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a [ReferenceExists](ctp:api:type:ReferenceExistsError) error is returned.

The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.

      Parameters

      • methodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs: {
                expand?: string | string[];
                version: number;
                [key: string]: QueryParam;
            };
        }

      Returns ApiRequest<RecurrencePolicy>

    • Retrieves a Recurrence Policy with the provided id.

      The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.

      Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
        }

      Returns ApiRequest<RecurrencePolicy>

    • Checks if a Recurrence Policy exists with the provided id. Returns a 200 status if the Recurrence Policy exists, or a NotFound error otherwise.

      The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.

      Parameters

      • OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }

      Returns ApiRequest<void>

    post

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods