PATCH
/
api
/
v1
/
subscription-profile
/
{id}
/
accept
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "member": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "email": "jsmith@example.com",
    "localCenter": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "type": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "namePlural": "<string>",
      "position": 123,
      "options": [
        "<string>"
      ],
      "chartName": "<string>"
    },
    "fullName": "<string>",
    "timezone": "<string>",
    "phoneNumber": "<string>",
    "cardId": "<string>",
    "isValidatedIdentity": true,
    "isValidatedIdentityPending": true,
    "postalCode": "<string>",
    "address": "<string>",
    "professionOrganisation": "<string>",
    "professionOrganisationRole": "<string>",
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "companyRegNo": "<string>"
  },
  "productPrice": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "currency": "<string>",
    "price": 123,
    "name": "<string>",
    "isSubscription": true,
    "isRestricted": "<string>",
    "isDefault": true,
    "fullDescription": "<string>",
    "displayNameOnPaymentPage": true,
    "overwriteMonthPeriod": 123,
    "isHidden": true,
    "isBundle": true,
    "isBundleMember": true,
    "monthPeriod": 123
  },
  "currency": "<string>",
  "currentPeriodEnd": "2023-11-07T05:31:56Z",
  "stripeCustomerId": "<string>",
  "stripeSubscriptionId": "<string>",
  "isSubscriptionInactive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "isSubscriptionCanceled": true,
  "customPriceValue": 123,
  "profileExternal": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "organisation": "<string>",
    "role": "<string>",
    "twitter": "<string>",
    "linkedin": "<string>",
    "instagram": "<string>",
    "country": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "name": "<string>"
    },
    "isNewsletterSubscribed": true,
    "town": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "name": "<string>"
    },
    "isValidatedIdentity": true,
    "isValidatedIdentityPending": true,
    "isCreateAccount": true,
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "customFieldValues": [
      "https://example.com/"
    ],
    "professionOrganisationRole": "<string>",
    "companyRegNo": "<string>",
    "fullName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "status": "<string>",
  "uid": "<string>",
  "isPublic": true,
  "identity": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "isValidated": true,
    "hasUploadedDocument": true,
    "firstName": "<string>",
    "lastName": "<string>",
    "status": "<string>"
  },
  "identityReminderSent": true,
  "localCenterOption": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>"
  },
  "identityReminder2Sent": true,
  "identityReminder3Sent": true
}

Path Parameters

id
string
required

SubscriptionProfile identifier

Body

application/merge-patch+json

The updated SubscriptionProfile resource

member
string<iri-reference> | null
Example:

"https://example.com/"

productPrice
string<iri-reference> | null
Example:

"https://example.com/"

currency
string | null
currentPeriodEnd
string<date-time> | null
stripeCustomerId
string | null
stripeSubscriptionId
string | null
isSubscriptionInactive
boolean | null
isFailedPayment
boolean | null
product
string<iri-reference>
Example:

"https://example.com/"

createdAt
string<date-time>
isSubscriptionCanceled
boolean | null
customPriceValue
integer | null
profileExternal
string<iri-reference> | null
Example:

"https://example.com/"

tenant
string<iri-reference> | null
Example:

"https://example.com/"

status
string | null
token
string | null
uid
string | null
acceptedBy
string<iri-reference> | null
Example:

"https://example.com/"

acceptedDate
string<date-time> | null
isPublic
boolean | null
productOption
string<iri-reference> | null
Example:

"https://example.com/"

requestPayload
string[] | null
identity
string<iri-reference> | null
Example:

"https://example.com/"

checkoutReminderSent
boolean | null
identityReminderSent
boolean | null
identityExpiringRequested
boolean | null
localCenterOption
string<iri-reference> | null
Example:

"https://example.com/"

identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null
commentByUser
string | null

Response

SubscriptionProfile resource updated

@context
@id
string
@type
string
id
integer
member
object | null
productPrice
object | null
currency
string | null
currentPeriodEnd
string<date-time> | null
stripeCustomerId
string | null
stripeSubscriptionId
string | null
isSubscriptionInactive
boolean | null
createdAt
string<date-time>
isSubscriptionCanceled
boolean | null
customPriceValue
integer | null
profileExternal
object | null
status
string | null
uid
string | null
isPublic
boolean | null
identity
object | null
identityReminderSent
boolean | null
localCenterOption
object | null
identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null