Documentation

1Subscribers

A subscriber represents your actual customer. It provides an easy way to process payments. Typically, you’ll store additional data on the subscriber object, like an address or an external_id that identifies the subscriber in your system. The email address is a required field that has to be provided for the subscriber.

1.1Create a Subscriber via the Backend

You can create subscribers via the backend by clicking on Space > Subscription > Subscribers.

iframe
Figure 1. Create a subscriber via the backend.
Note
You do have the option to explicitly allow and disallow payment methods on the subscriber. This overrides the configuration on the subscription product. It is important for subscriptions to note that you can only use connectors that support tokenization. If the feature is supported can be seen on the connector information page.
iframe
Figure 2. Check the supported feature on the connector information page. Here as an example for the Bogus AMEX connector.

In the create state you should provide as many information as you have. In case additional information should be necessary to create a payment with a specific payment method then we are going to ask for them in the payment process.

1.1.1Web Service API

Alternatively, you can also use the web service API to create a subscriber via the Subscriber Service.

Once the customer is created you can subscribe the customer to a plan by creating a subscription.

Request

{
    "billingAddress": {
        "city": "Winterthur",
        "country": "Switzerland",
        "emailAddress": "kruesi@customweb.com",
        "familyName": "Kruesi",
        "gender": "MALE",
        "givenName": "Sascha",
        "postCode": "8400",
        "street": "General-Guisan-Strasse 47"
    },
    "emailAddress": "sascha.kruesi@customweb.com",
    "externalId": "customer-nr-101",
    "reference": "customer-nr-101",
    "shippingAddress": {
        "city": "Winterthur",
        "country": "Switzerland",
        "emailAddress": "kruesi@customweb.com",
        "familyName": "Kruesi",
        "gender": "MALE",
        "givenName": "Sascha",
        "postCode": "8400",
        "street": "General-Guisan-Strasse 47"
    }
}

Response

{
	"additionalAllowedPaymentMethodConfigurations": [],
	"billingAddress": {
		"city": "Winterthur",
		"commercialRegisterNumber": null,
		"country": null,
		"dateOfBirth": null,
		"dependentLocality": null,
		"emailAddress": "kruesi@customweb.com",
		"familyName": "Kruesi",
		"gender": "MALE",
		"givenName": "Sascha",
		"legalOrganizationForm": null,
		"mobilePhoneNumber": null,
		"organizationName": null,
		"phoneNumber": null,
		"postCode": "8400",
		"postalState": null,
		"salesTaxNumber": null,
		"salutation": null,
		"socialSecurityNumber": null,
		"sortingCode": null,
		"street": "General-Guisan-Strasse 47"
	},
	"description": null,
	"disallowedPaymentMethodConfigurations": [],
	"emailAddress": "sascha.kruesi@customweb.com",
	"externalId": "customer-nr-101",
	"id": 1,
	"language": "en-GB",
	"linkedSpaceId": 1,
	"plannedPurgeDate": null,
	"reference": "customer-nr-101",
	"shippingAddress": {
		"city": "Winterthur",
		"commercialRegisterNumber": null,
		"country": null,
		"dateOfBirth": null,
		"dependentLocality": null,
		"emailAddress": "kruesi@customweb.com",
		"familyName": "Kruesi",
		"gender": "MALE",
		"givenName": "Sascha",
		"legalOrganizationForm": null,
		"mobilePhoneNumber": null,
		"organizationName": null,
		"phoneNumber": null,
		"postCode": "8400",
		"postalState": null,
		"salesTaxNumber": null,
		"salutation": null,
		"socialSecurityNumber": null,
		"sortingCode": null,
		"street": "General-Guisan-Strasse 47"
	},
	"state": "ACTIVE",
	"version": 1
}

1.2Delete a Subscriber via the backend.

You can delete subscribers via the backend by clicking on the delete button inside Space > Subscription > Subscribers.

1.3Delete a Subscriber via the Web Service API

Alternatively, you can also use the web service API to delete a subscriber via the Subscriber Service.