GET
/
api
/
v1
/
product_payments
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "product": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "uuid": "<string>",
        "id": 123,
        "name": "<string>",
        "hasSubscription": true,
        "hasOneTimePayment": true,
        "logo": "<string>",
        "settings": {
          "tenantLogo": true,
          "showTitle": true,
          "colorSelection": null,
          "colorButton": null,
          "disableSubscribe": false,
          "commentSection": true,
          "newestAndTopDonationSection": true,
          "requireFullAddress": false,
          "disableRegister": false,
          "lightThemeOnly": false,
          "isThankYouSingular": false
        },
        "event": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "uuid": "<string>",
          "name": "<string>",
          "location": "<string>",
          "description": "<string>",
          "logo": "<string>",
          "type": "https://example.com/",
          "dateCreated": "2023-11-07T05:31:56Z",
          "eventMedia": [
            {
              "@context": "<string>",
              "@id": "<string>",
              "@type": "<string>",
              "id": 123,
              "media": "https://example.com/"
            }
          ],
          "logoFromAlbum": "<string>",
          "dateTimeBegin": "2023-11-07T05:31:56Z",
          "dateTimeEnd": "2023-11-07T05:31:56Z",
          "meet": "<string>",
          "isOnline": true,
          "settings": {
            "tenantLogo": true,
            "showTitle": true,
            "colorSelection": null,
            "colorButton": null,
            "disableSubscribe": false,
            "disableRegister": true,
            "lightThemeOnly": false,
            "isThankYouSingular": false,
            "fieldName": true,
            "fieldEmail": true,
            "fieldPhone": false,
            "fieldOrganisation": false,
            "fieldRole": false,
            "fieldTown": false,
            "fieldLinkedin": false,
            "fieldX": false,
            "fieldInstagram": false
          },
          "sdg": [
            "<string>"
          ],
          "isPublic": true,
          "hasEventTicketing": true,
          "isPast": true,
          "status": "draft"
        },
        "type": "<string>",
        "displayOnProfile": true,
        "productPriceVariations": [
          "https://example.com/"
        ],
        "metaGraphImage": "<string>"
      },
      "subscriptionProfile": {
        "@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
      },
      "amount": 123,
      "periodStart": "2023-11-07T05:31:56Z",
      "periodEnd": "2023-11-07T05:31:56Z",
      "stripeInvoiceId": "<string>",
      "stripePaymentId": "<string>",
      "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>"
      },
      "user": {
        "@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>"
      },
      "price": {
        "@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
      },
      "manualFeePayment": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "status": 123,
        "dateModified": "2023-11-07T05:31:56Z"
      },
      "stripePaymentDate": "2023-11-07T05:31:56Z",
      "status": "open",
      "acceptedDate": "2023-11-07T05:31:56Z",
      "uid": "<string>",
      "currency": "<string>",
      "isPublic": true,
      "identityReminderSent": true,
      "productOption": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "isArchived": true
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "identity": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "isValidated": true,
        "hasUploadedDocument": true,
        "firstName": "<string>",
        "lastName": "<string>",
        "status": "<string>"
      },
      "localCenterOption": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "identityReminder2Sent": true,
      "identityReminder3Sent": true,
      "commentByUser": "<string>",
      "commentStatus": "<string>",
      "invoice": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "invoiceNumber": 123
      }
    }
  ],
  "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

​
profileExternal
string
​
profileExternal[]
string[]
​
productOption
string
​
productOption[]
string[]
​
product.uuid
string
​
product.uuid[]
string[]
​
product.type
string
​
product.type[]
string[]
​
id
integer
​
id[]
integer[]
​
status
string
​
status[]
string[]
​
user
string
​
user[]
string[]
​
user.localCenter
string
​
user.localCenter[]
string[]
​
user.status
string
​
user.status[]
string[]
​
manualFeePayment
string
​
manualFeePayment[]
string[]
​
commentStatus
string
​
commentStatus[]
string[]
​
commentByUser
string
​
order[productOption.id]
enum<string>
default:asc
Available options:
asc,
desc
​
order[user.type.position]
enum<string>
default:asc
Available options:
asc,
desc
​
order[periodStart]
enum<string>
default:asc
Available options:
asc,
desc
​
order[periodEnd]
enum<string>
default:asc
Available options:
asc,
desc
​
order[id]
enum<string>
default:asc
Available options:
asc,
desc
​
order[user.lastName]
enum<string>
default:asc
Available options:
asc,
desc
​
order[stripePaymentDate]
enum<string>
default:asc
Available options:
asc,
desc
​
order[amount]
enum<string>
default:asc
Available options:
asc,
desc
​
order[status]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[isRefunded]
boolean
​
exists[subscriptionProfile]
boolean
​
exists[identityReminderSent]
boolean
​
exists[identityReminder2Sent]
boolean
​
exists[identityReminder3Sent]
boolean
​
exists[commentByUser]
boolean
​
periodStart[before]
string
​
periodStart[strictly_before]
string
​
periodStart[after]
string
​
periodStart[strictly_after]
string
​
periodEnd[before]
string
​
periodEnd[strictly_before]
string
​
periodEnd[after]
string
​
periodEnd[strictly_after]
string
​
stripePaymentDate[before]
string
​
stripePaymentDate[strictly_before]
string
​
stripePaymentDate[after]
string
​
stripePaymentDate[strictly_after]
string

Response

200
application/ld+json

ProductPayment collection

The response is of type object.