Skip to content

getByIdPartnerCustomer

Request

Path
idinteger, (int32)required
GET
/api/v1/partner/subscription/{id}
curl -i -X GET \
  'https://api.prana.software/api/v1/partner/subscription/{id}'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
createdOnstring, (date-time)

Creation date and time.

Default:""
modifiedOnstring, (date-time)

Last modification date and time.

Default:""
partnerobject(ApiPartnerListReadDto)

Partner information.

Default:""
companyobject(ApiManagementCompanyListReadDto)

Associated company.

Default:""
commercialNamestring

Commercial name.

Default:""
cifstring

Customer CIF.

Default:""
Example:"A12345678"
namestring

Customer name.

Default:""
discountnumber

Discount percentage.

Default:""
Example:5
webstring

Customer website URL.

Default:""
contactPersonstring

Contact person name.

Default:""
firstPhoneNumberstring

First phone number.

Default:""
Example:"+34912345678"
secondPhoneNumberstring

Second phone number.

Default:""
Example:"+34912345679"
emailstring

Contact email.

Default:""
Example:"customer@example.com"
countryobject(ApiManagementCountryListReadDto)

Customer country.

Default:""
stateobject(ApiManagementStateListReadDto)

Customer state.

Default:""
addressstring

Street address.

Default:""
postalCodestring

Postal code.

Default:""
Example:"28001"
citystring

City name.

Default:""
activeboolean

Active flag.

Default:false
Example:true
invitationCodestring

Invitation code.

Default:""
invitationSentOnstring, (date-time)

Invitation sent date and time.

Default:""
invitationAcceptedOnstring, (date-time)

Invitation accepted date and time.

Default:""
planobject(ApiPlanListReadDto)

Subscription plan.

Default:""
periodobject(ApiManagementPeriodListReadDto)

Billing period.

Default:""
moduleOnBoardingobject(ApiModuleListReadDto)

Module onboarding.

Default:""
statusstring(ApiPartnerStatusEnum)

Partner customer status.

Default:""
Enum:"ACTIVE""INACTIVE""PENDING"
companyNamestring

Associated company name.

Default:""
companyOwnerEmailstring

Company owner email.

Default:""
Example:"owner@example.com"
externalCodestring

External customer code.

Default:""
newsletterboolean

Newsletter subscription flag.

Default:false
Example:true
lastAccessstring, (date-time)

Last access date and time.

Default:""
cancellationDatestring, (date-time)

Cancellation date and time.

Default:""
cancellationReasonstring

Cancellation reason.

Default:""
terminateDatestring, (date-time)

Termination date and time.

Default:""
terminateReasonstring

Termination reason.

Default:""
companyTypestring(ApiManagementCompanyTypeEnum)

Company type.

Default:""
Enum:"SELF_EMPLOYED""COMPANY""CONSULTANT_COMPANY"
employeesstring(ApiCompanyUsersRangeEnum)

Number of employees range.

Default:""
Enum:"ONE""FIVE""TEN""TWENTY_FIVE""FIFTY""BIGGER"
igicboolean

IGIC tax flag for Canary Islands.

Default:false
Example:false
directDebitAllowedboolean

Direct debit payment method allowed

Default:false
Example:false
Response
// No response example