GET
/
api
/
v1
/
subscription_profiles
{
  "hydra:member": [
    {
      "@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
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

id
integer
id[]
integer[]
productOption
string
productOption[]
string[]
productPrice
string
productPrice[]
string[]
product.uuid
string
product.uuid[]
string[]
status
string
status[]
string[]
member
string
member[]
string[]
member.lastName
string
profileExternal.name
string
profileExternal
string
profileExternal[]
string[]
order[createdAt]
enum<string>
default:asc
Available options:
asc,
desc
order[productOption.id]
enum<string>
default:asc
Available options:
asc,
desc
order[currentPeriodEnd]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
currentPeriodEnd[before]
string
currentPeriodEnd[strictly_before]
string
currentPeriodEnd[after]
string
currentPeriodEnd[strictly_after]
string
exists[isSubscriptionInactive]
boolean
exists[isSubscriptionCanceled]
boolean
exists[member]
boolean
exists[profileExternal]
boolean

Response

200
application/ld+json

SubscriptionProfile collection

The response is of type object.