Memberships
Restore a membership
Restores an archived (soft-deleted) Membership, returning it to active use.
The membership must currently be archived; restoring a membership that is not archived returns a 400 response.
post/customers/memberships/{membershipId}/restore
Response
The Membership was successfully retrieved
Example response
{
"data": {
"customer": {
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"last_check_in": {
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"original_url": "https://example.com/media/super-cool-photo.jpg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
},
"external_ref": "ext-cust-789012"
},
"members": [
{
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_charge": {
"amount": 3995,
"currency": "GBP"
},
"payment_method": {
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"notice_period": "P1M",
"private": true
},
"type": {
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"min_members": 2,
"max_members": 4,
"rates": [
{
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"notice_period": "P1M",
"private": true
}
],
"revenue_schedule": "FREQ=WEEKLY"
}
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.