Archieve Recurring charge

PUT

https://api.mpc.dev.placewise.com/v1/billing/recurring_charges/{id}/archive

API Permit:Billing:Api:RecurringCharge:Update

API Context:Customer

Authorizations:UserToken

Request

Path Params

integer

required

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.mpc.dev.placewise.com/v1/billing/recurring_charges//archive' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

recurring_charge

object (RecurringCharge)

required

integer <uint64>

read-onlyrequired

Example:

name

string

required

customer_id

integer <uint64>

read-onlyrequired

Customer the record is assigned to

Example:

447

from

string <date> | null

required

Must be a first day of month

price

number

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

discarded_at

string <date-time>

required

Example:

2022-11-09T16:25:58.099512Z

Example

{
    "recurring_charge": {
        "id": 1,
        "name": "string",
        "customer_id": 447,
        "from": "2019-08-24",
        "price": 0,
        "created_at": "2022-11-05T16:25:58.099512Z",
        "updated_at": "2022-11-15T16:25:58.099512Z",
        "discarded_at": "2022-11-09T16:25:58.099512Z"
    }
}

🟠404Record Not Found

🟠422Invalid Parameters

Modified at 2025-04-29 13:08:16

RecurringCharge Model

Restore Recurring charge